Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Merged
merged 1 commit into from
Oct 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

For the git repository we have enabled branch protection for the main and staging (development) branches. This means that changes can only be made to them via pull requests and certain rules must be followed in order to merge them from said pull request.

# Note
* `mypy.ini` must be in the root of the repo (not in any folder)

## Pull requests
* When a new commit is made to the branch, it automatically updates the pull request with said changes
* All comments made by reviewers on the code in the pull request must be marked as resolved before it can be merged
Expand Down Expand Up @@ -31,4 +34,4 @@ The work flow that is currently set up are a linter and type validator for pytho
* Warns about casting an expression to its inferred type.

# VScode Extensions
this repo has extensions that are recommended to install for programming in this project those extensions see `@recommended` in extensions
this repo has extensions that are recommended to install for programming in this project those extensions see `@recommended` in extensions
Loading