Skip to content

Commit 992dedc

Browse files
authored
feat!: readme restart (#11)
1 parent d131bfc commit 992dedc

File tree

1 file changed

+1
-76
lines changed

1 file changed

+1
-76
lines changed

README.md

Lines changed: 1 addition & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1 @@
1-
# Git Repository Template
2-
3-
[Template](https://github.com/DynamicYield/template) is a [*Git repository template*](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for bootstrapping your repositories.
4-
5-
Bundled support for:
6-
7-
- [Code Owners](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#about-code-owners) — Automatically requested for review when someone opens a pull request that modifies code that they own as defined in [`.github/CODEOWNERS`](.github/CODEOWNERS)
8-
9-
- The first thing you should do, is **set a [team](https://github.com/AI21/template/blob/main/.github/CODEOWNERS) as a code owner for the `.github/settings.yml`**.
10-
11-
- [ProBot Settings](https://github.com/probot/settings) — Synchronize repository settings defined in [`.github/settings.yml`](.github/settings.yml) to GitHub, enabling Pull Requests for repository settings
12-
13-
When adding/removing/modifying jobs within workflows, you might need to tweak the *required status checks* in this file; the required status checks must pass before you can merge your branch into the protected branch.
14-
15-
- [ProBot Stale](https://github.com/probot/stale/) — Closes abandoned Issues and Pull Requests after a period of inactivity as defined in [`.github/stale.yml`](.github/stale.yml)
16-
- [DependaBot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates) — Alerts on security vulnerabilities within the repository's dependencies, and updates the dependencies automatically as defined in [`.github/dependabot.yml`](.github/dependabot.yml)
17-
- [RenovateBot](https://github.com/renovatebot/renovate) — Universal dependency update tool as defined in [`.github/renovate.json`](.github/renovate.json) ([application dashboard](https://app.renovatebot.com))
18-
- [Pre-commit](https://pre-commit.com/) — Managing and maintaining multi-language pre-commit hooks as defined in [`.pre-commit-config.yaml`](.pre-commit-config.yaml)
19-
20-
- Leverage `pre-commit` to [install the Git hooks](https://pre-commit.com/#pre-commit-install)
21-
22-
```shell
23-
pre-commit install --install-hooks -t pre-commit -t commit-msg
24-
```
25-
26-
- You can check which files `pre-commit` works on by running
27-
28-
```shell
29-
pre-commit run list-files --hook-stage manual --verbose
30-
```
31-
32-
- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) — An easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. Such as generating a [changelog](https://keepachangelog.com/)
33-
34-
```shell
35-
git cz changelog
36-
```
37-
38-
---
39-
40-
## Automation Features
41-
42-
We **strongly recommend** to enable the following features manually
43-
44-
### Code review assignment
45-
46-
[Code review assignments clearly indicate which members of a team are expected to submit a review for a pull request](https://docs.github.com/en/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team).
47-
48-
### Scheduled reminders
49-
50-
You can get reminders in Slack when your [team has pull requests waiting for review](https://docs.github.com/en/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team#creating-a-scheduled-reminder-for-a-team) or for [your user with real-time alerts](https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders).
51-
52-
## Prerequisites
53-
54-
We are using a collection of tools. In order to work with this repository please [configure your Mac](https://github.com/AI21/dev-envs#getting-started)
55-
56-
## Quick Start
57-
58-
Run [`./bootstrap.sh`](./bootstrap.sh) and follow the interactive on-screen instructions. For more information, Run `./bootstrap.sh --help`.
59-
60-
This will install pre-commit hooks, modify relevant files, deletes itself and open a draft pull-request.
61-
62-
## Syncing with the Template repository
63-
64-
To keep your repository up-to-date with the template git repository, execute the following from within your repository's root directory
65-
66-
```shell
67-
git clone git@github.com:AI21/template.git ../template
68-
git checkout -b template-sync
69-
rsync -ax --exclude .git --exclude README.md --exclude CHANGELOG.md --exclude bootstrap.sh ../template/ .
70-
```
71-
72-
Then do cherry-picking for the changes which you would like to merge.
73-
74-
---
75-
76-
## Modify this README to suit the project
1+
### AI21 Python SDK

0 commit comments

Comments
 (0)