Skip to content

Add initial repo and code standards #464

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

Merged
merged 2 commits into from
Nov 2, 2021
Merged
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions docs/index-team_guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Guides for JupyterHub teams

team/member-guide
team/skills
team/repository-code-standards
team/adding-members
team/shared-infrastructure
talking
37 changes: 37 additions & 0 deletions docs/team/repository-code-standards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Repository Management and Code Standards

JupyterHub projects should take advantage of pre-commit and tools to help maintain consistent formatting within a repo to improve overall code quality, review efficiency, and readability of code.
Sensible use of pre-commit to run formatting tools and code linters can add consistency and improve maintainability.

## Preferred tools and pre-commit hooks

The team has found the following tools and their pre-commit hooks to be useful. The following pre-commit hooks can be added to any repo when convenient, though please communicate with anyone who has an open pull request if it will lead to major conflicts:

- [black](https://black.readthedocs.io/)
- [prettier](https://prettier.io/)
- [flake8](https://flake8.pycqa.org/en/latest/)
- **TODO: standard pre-commit hooks, such as isort, etc. (To be determined and listed here)**

## Applying to repos

When creating a new repo, please use any pre-commit hooks and tools that are useful.

When working with an existing repo, please balance the benefits of adding a tool or pre-commit hook with considerations such as
- the amount of code churn
- how it will improve code maintainability
- the time it may add to CI runs.

## Configuration of a tool

In general using the default settings for tools is preferred, but use your judgment as to whether to apply a stricter or more lenient configuration for linting code.
Example configurations are in:

- [JupyterHub](https://github.com/jupyterhub/jupyterhub/) (a large repository which was converted and therefore has a fairly lax configuration)
- [nativeauthenticator](https://github.com/jupyterhub/nativeauthenticator) (a fairly strict configuration)

Other linters, autoformatters and tools can be added to other repos on an ad-hoc basis if it's not too disruptive- this is a good way to try out new tools.
In general, big changes should not be made to high profile repos without prior discussion.

## Proposing organization-wide use of a tool

If the new tool is useful across the organisation please propose it in a new team-compass GitHub issue, outlining the advantages and disadvantages.