From eed9d9f377688825699095af8798c53dc469fdad Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 15 Feb 2022 09:58:37 -0800 Subject: [PATCH 1/8] fix typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0bbd6c8ea..70e8aa83b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -There's still lots of things to be done, just have a look at that issue log. If you feel like conctributing to the project, please do! Bug fixes and improvements to the front end (I just can't seem to get some of these CSS things right) are always welcome. +There's still lots of things to be done, just have a look at that issue log. If you feel like contributing to the project, please do! Bug fixes and improvements to the front end (I just can't seem to get some of these CSS things right) are always welcome. If you want to implement something big: Please start a discussion about that in the issues! Maybe I've already had something similar in mind and we can make it happen together. However, keep in mind that the general roadmap is to make the existing features stable and get them tested. See the roadmap in the readme. From bcfce4648102dc90fa8a87c532b1f101b8a4f437 Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 15 Feb 2022 09:59:32 -0800 Subject: [PATCH 2/8] roadmap does not exist --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70e8aa83b..a5620b39d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ There's still lots of things to be done, just have a look at that issue log. If you feel like contributing to the project, please do! Bug fixes and improvements to the front end (I just can't seem to get some of these CSS things right) are always welcome. -If you want to implement something big: Please start a discussion about that in the issues! Maybe I've already had something similar in mind and we can make it happen together. However, keep in mind that the general roadmap is to make the existing features stable and get them tested. See the roadmap in the readme. +If you want to implement something big: Please start a discussion about that in the issues! Maybe I've already had something similar in mind and we can make it happen together. * When making additions to the project, consider if the majority of users will benefit from your change. If not, you're probably better of forking the project. * Also consider if your change will get in the way of other users. A good change is a change that enhances the experience of some users who want that change and does not affect users who do not care about the change. From dcaf6ad5cd038c5fb2c313fecf6eb6f3e303153e Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 15 Feb 2022 10:10:09 -0800 Subject: [PATCH 3/8] minor typos and clarifications --- CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a5620b39d..5c0841984 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contributing -There's still lots of things to be done, just have a look at that issue log. If you feel like contributing to the project, please do! Bug fixes and improvements to the front end (I just can't seem to get some of these CSS things right) are always welcome. +If you feel like contributing to the project, please do! Bug fixes and improvements are always welcome. -If you want to implement something big: Please start a discussion about that in the issues! Maybe I've already had something similar in mind and we can make it happen together. +If you want to implement something big: Please start a discussion about that in the issues! Maybe something similar is already in development and we can make it happen together. * When making additions to the project, consider if the majority of users will benefit from your change. If not, you're probably better of forking the project. * Also consider if your change will get in the way of other users. A good change is a change that enhances the experience of some users who want that change and does not affect users who do not care about the change. @@ -13,17 +13,17 @@ Paperless supports python 3.6, 3.7, 3.8 and 3.9. ## Branches -master always reflects the latest release. Apart from changes to the documentation or readme, absolutely no functional changes on this branch in between releases. +`master` always reflects the latest release. Apart from changes to the documentation or readme, absolutely no functional changes on this branch in between releases. -dev contains all changes that will be part of the next release. Use this branch to start making your changes. +`dev` contains all changes that will be part of the next release. Use this branch to start making your changes. -feature-X branches is for experimental stuff that will eventually be merged into dev, and then released as part of the next release. +`feature-X` branches are for experimental stuff that will eventually be merged into dev. ## Testing: -I'm trying to get most of paperless tested, so please do the same for your code! I know its a hassle, but it makes sure that your code works now and will allow us to detect regressions easily. +Please test your code! I know its a hassle, but it makes sure that your code works now and will allow us to detect regressions easily. -To test your code, execute `pytest` in the src/ directory. Executing that in the project root is no good. This also generates a html coverage report, which you can use to see if you missed anything important during testing. +To test your code, execute `pytest` in the src/ directory. This also generates a html coverage report, which you can use to see if you missed anything important during testing. ## More info: From dc3f994a1f586c527e657b9f8363ffae4c988236 Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 15 Feb 2022 10:50:03 -0800 Subject: [PATCH 4/8] add PRs and Non-Trivial process --- CONTRIBUTING.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c0841984..e9517f25f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,10 +2,12 @@ If you feel like contributing to the project, please do! Bug fixes and improvements are always welcome. -If you want to implement something big: Please start a discussion about that in the issues! Maybe something similar is already in development and we can make it happen together. +If you want to implement something big: +* Please start a discussion about that in the issues! Maybe something similar is already in development and we can make it happen together. * When making additions to the project, consider if the majority of users will benefit from your change. If not, you're probably better of forking the project. * Also consider if your change will get in the way of other users. A good change is a change that enhances the experience of some users who want that change and does not affect users who do not care about the change. +* Please see the [paperless-ngx merge process](#merging-non-trivial-prs) below. ## Python @@ -28,3 +30,28 @@ To test your code, execute `pytest` in the src/ directory. This also generates a ## More info: ... is available in the documentation. https://paperless-ng.readthedocs.io/en/latest/extending.html + +# Merging PRs + +Once you have submitted a **P**ull **R**equest it will be reviewed, approved, and merged by one or more community members of any team. Automated code tests and formatting checks must be passed. + +## Non-Trivial Requests + +PRs deemed `non-trivial` will go through a stricter review process before being merged into `dev`. This is to ensure code quality and complete functionality (free of side effects). + +Examples of `non-trivial` PRs might include: + +* Additional features +* Large changes to many distinct files +* Breaking or depreciation of existing features + +Our community review process for `non-trivial` prs is the following: + +1. Must pass usual automated code tests and formatting checks. +2. The PR will be assigned and pinged to the appropriately experienced team (i.e. @paperless-ngx/backend for backend changes). +3. Development team will check and test code manually (possibly over several days). + - You may be asked to make changes or rebase. + - The team may ask for additional testing done by @paperless-ngx/test +4. **Two or three** members of the team will approve and finally merge the request into `dev` 🎉. + +This process might be slow as community members have different schedules and time to dedicate to the Paperless project. However it ensures community code reviews are as brilliantly thorough as they once were with @jonaswinkler. From d76829525fd77c020fd51c62928ff1c3fc8a232a Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 15 Feb 2022 10:59:56 -0800 Subject: [PATCH 5/8] Wow that's a rigid test, love it --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9517f25f..0f69bba82 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,7 @@ Our community review process for `non-trivial` prs is the following: 1. Must pass usual automated code tests and formatting checks. 2. The PR will be assigned and pinged to the appropriately experienced team (i.e. @paperless-ngx/backend for backend changes). 3. Development team will check and test code manually (possibly over several days). - - You may be asked to make changes or rebase. + - You may be asked to make changes or rebase. - The team may ask for additional testing done by @paperless-ngx/test 4. **Two or three** members of the team will approve and finally merge the request into `dev` 🎉. From ae77b60ef3ea2990778785f50c1b198841874e66 Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 15 Feb 2022 11:01:15 -0800 Subject: [PATCH 6/8] Remove trailing whitespace --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f69bba82..d758ce0e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ If you feel like contributing to the project, please do! Bug fixes and improvements are always welcome. -If you want to implement something big: +If you want to implement something big: * Please start a discussion about that in the issues! Maybe something similar is already in development and we can make it happen together. * When making additions to the project, consider if the majority of users will benefit from your change. If not, you're probably better of forking the project. From 9f2ad7b52888516fb75c60c3427b094263194156 Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 15 Feb 2022 11:03:10 -0800 Subject: [PATCH 7/8] Update header link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d758ce0e4..b40ba9c0a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ If you want to implement something big: * Please start a discussion about that in the issues! Maybe something similar is already in development and we can make it happen together. * When making additions to the project, consider if the majority of users will benefit from your change. If not, you're probably better of forking the project. * Also consider if your change will get in the way of other users. A good change is a change that enhances the experience of some users who want that change and does not affect users who do not care about the change. -* Please see the [paperless-ngx merge process](#merging-non-trivial-prs) below. +* Please see the [paperless-ngx merge process](#merging-prs) below. ## Python From 6807246e967e90a69e9cf5efdb9c72f40dc1a6aa Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 15 Feb 2022 14:08:02 -0800 Subject: [PATCH 8/8] Typos and clarifications --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b40ba9c0a..3712af83e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Paperless supports python 3.6, 3.7, 3.8 and 3.9. ## Testing: -Please test your code! I know its a hassle, but it makes sure that your code works now and will allow us to detect regressions easily. +Please test your code! I know it's a hassle, but it makes sure that your code works now and will allow us to detect regressions easily. To test your code, execute `pytest` in the src/ directory. This also generates a html coverage report, which you can use to see if you missed anything important during testing. @@ -45,13 +45,13 @@ Examples of `non-trivial` PRs might include: * Large changes to many distinct files * Breaking or depreciation of existing features -Our community review process for `non-trivial` prs is the following: +Our community review process for `non-trivial` PRs is the following: 1. Must pass usual automated code tests and formatting checks. 2. The PR will be assigned and pinged to the appropriately experienced team (i.e. @paperless-ngx/backend for backend changes). 3. Development team will check and test code manually (possibly over several days). - You may be asked to make changes or rebase. - The team may ask for additional testing done by @paperless-ngx/test -4. **Two or three** members of the team will approve and finally merge the request into `dev` 🎉. +4. **At least two** members of the team will approve and finally merge the request into `dev` 🎉. This process might be slow as community members have different schedules and time to dedicate to the Paperless project. However it ensures community code reviews are as brilliantly thorough as they once were with @jonaswinkler.