Skip to content

docs: added summary section to contributing docs #573

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.

Sign up for GitHub

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 4 commits into from
Feb 23, 2022
Merged

docs: added summary section to contributing docs #573

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cce6379
docs: added tl;dr; section to contributing docs
dreamorosi Feb 23, 2022
98cbae4
Update CONTRIBUTING.md
dreamorosi Feb 23, 2022
4b4487d
Update CONTRIBUTING.md
dreamorosi Feb 23, 2022
c5640e5
Update CONTRIBUTING.md
dreamorosi Feb 23, 2022
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
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ reported the issue. Please try to include as much information as you can. Detail

Contributions via pull requests are much appreciated.

### Summary
* This project uses `[email protected]` and `[email protected]` for development (see [Setup](#setup))
* Before opening a PR, find an existing issue or open a new one to discuss the proposed change. PR without an issue or discussion has high risk of being rejected. We don't want to you to waste time. And it is very uncomfortable for us to reject a PR
* After your proposal has been reviewed and accepted by at least one of the project's maintainers, you can submit a pull request
* When opening a PR make sure to follow the checklist inside the pull request template

### Step 1: Find something to work on

If you want to contribute a specific feature or fix you have in mind, look at active [pull
Expand Down Expand Up @@ -287,7 +293,7 @@ You can build and start a local docs website by running these two commands:
Category | Convention
------------------------------------------------- | ---------------------------------------------------------------------------------
**Docstring** | We use [JSDoc](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) annotations to provide type information and create API references.
**Style guide** | We use black as well as flake8 extensions to enforce beyond good practices [PEP8](https://pep8.org/).
**Style guide** | We use `eslint` to keep our code consistent in terms of style and reducing defects.
**Test coverage** | We use [Jest](https://jestjs.io/) to test our code and [Codecov](https://codecov.io/) to report test coverage. We aim to have 100% test coverage in our unit tests.
**Git commits** | We follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). These are not enforced as we squash and merge PRs, but PR titles are enforced during CI.
**Documentation** | API reference docs are generated from docstrings which should have Examples section to allow developers to have what they need within their own IDE. Documentation website covers the wider usage, tips, and strives to be concise.
Expand Down