From cce6379e0a2e10984b6ad3dba794a7d0e451e5aa Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Wed, 23 Feb 2022 11:16:18 +0100 Subject: [PATCH 1/4] docs: added tl;dr; section to contributing docs --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ecb0326663..8e6451fa42 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. +### TL;DR; +* This project uses `node@14.x` and `npm@8.x` for development (see [Setup](#setup)) +* Before opening a PR, find an existing issue or open a new one to discuss the proposed change (we would hate it for you to have to waste time) +* 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 @@ -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. From 98cbae44576fec3f5800fd20a125532dd5ef0fbb Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Wed, 23 Feb 2022 12:33:46 +0100 Subject: [PATCH 2/4] Update CONTRIBUTING.md Co-authored-by: ijemmy --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e6451fa42..269cd01504 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ Contributions via pull requests are much appreciated. ### TL;DR; * This project uses `node@14.x` and `npm@8.x` for development (see [Setup](#setup)) -* Before opening a PR, find an existing issue or open a new one to discuss the proposed change (we would hate it for you to have to waste time) +* 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 From 4b4487dbc743ac8c4a8db4cc37345dee76f3fd78 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Wed, 23 Feb 2022 12:33:56 +0100 Subject: [PATCH 3/4] Update CONTRIBUTING.md Co-authored-by: ijemmy --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 269cd01504..f4bcc8f72c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,7 @@ reported the issue. Please try to include as much information as you can. Detail Contributions via pull requests are much appreciated. -### TL;DR; +### Summary * This project uses `node@14.x` and `npm@8.x` 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 From c5640e527fd4cbb516895f3d169cf7bbc1e97bb5 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Wed, 23 Feb 2022 14:25:21 +0100 Subject: [PATCH 4/4] Update CONTRIBUTING.md Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4bcc8f72c..cf2d932f17 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ Contributions via pull requests are much appreciated. ### Summary * This project uses `node@14.x` and `npm@8.x` 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 +* 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. * 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