Skip to content

Commit 04caf46

Browse files
dreamorosiijemmysaragerion
authored
docs: added summary section to contributing docs (#573)
* docs: added tl;dr; section to contributing docs * Update CONTRIBUTING.md Co-authored-by: ijemmy <[email protected]> * Update CONTRIBUTING.md Co-authored-by: ijemmy <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Sara Gerion <[email protected]> Co-authored-by: ijemmy <[email protected]> Co-authored-by: Sara Gerion <[email protected]>
1 parent b006790 commit 04caf46

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ reported the issue. Please try to include as much information as you can. Detail
3232

3333
Contributions via pull requests are much appreciated.
3434

35+
### Summary
36+
* This project uses `[email protected]` and `[email protected]` for development (see [Setup](#setup))
37+
* Before opening a Pull Request, please find the existing related issue or open a new one to discuss the proposed change. A PR without a related issue or discussion has an high risk of being rejected. We are very appreciative and thankful for your time and efforts and we want to make sure they are not wasted.
38+
* After your proposal has been reviewed and accepted by at least one of the project's maintainers, you can submit a pull request
39+
* When opening a PR make sure to follow the checklist inside the pull request template
40+
3541
### Step 1: Find something to work on
3642

3743
If you want to contribute a specific feature or fix you have in mind, look at active [pull
@@ -287,7 +293,7 @@ You can build and start a local docs website by running these two commands:
287293
Category | Convention
288294
------------------------------------------------- | ---------------------------------------------------------------------------------
289295
**Docstring** | We use [JSDoc](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) annotations to provide type information and create API references.
290-
**Style guide** | We use black as well as flake8 extensions to enforce beyond good practices [PEP8](https://pep8.org/).
296+
**Style guide** | We use `eslint` to keep our code consistent in terms of style and reducing defects.
291297
**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.
292298
**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.
293299
**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.

0 commit comments

Comments
 (0)