diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 49e36e35b..1ffc7ebcb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,7 @@ ## Proposed change <!-- -Please include a summary of the change and which issue is fixed (if any) and any relevant motivation / context. List any dependencies that are required for this change. If appropriate, please include an explanation of how your poposed change can be tested. Screenshots and / or videos can also be helpful if appropriate. +Please include a summary of the change and which issue is fixed (if any) and any relevant motivation / context. List any dependencies that are required for this change. If appropriate, please include an explanation of how your poposed change can be tested. Screenshots and / or videos can also be helpful if appropriate. --> Fixes # (issue) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 0bb900f82..a0c3bb8ee 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the +- Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or +- The use of sexualized language or imagery, and sexual attention or advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an +standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e2a144e54..68fc44b84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -104,26 +104,26 @@ Paperless-ngx is a community project. We do our best to delegate permission and As of writing, there are 21 members in paperless-ngx. 4 of these people have complete administrative privileges to the repo: -* [@shamoon](https://github.com/shamoon) -* [@bauerj](https://github.com/bauerj) -* [@qcasey](https://github.com/qcasey) -* [@FrankStrieter](https://github.com/FrankStrieter) +- [@shamoon](https://github.com/shamoon) +- [@bauerj](https://github.com/bauerj) +- [@qcasey](https://github.com/qcasey) +- [@FrankStrieter](https://github.com/FrankStrieter) There are 5 teams collaborating on specific tasks within paperless-ngx: -* @paperless-ngx/backend (Python / django) -* @paperless-ngx/frontend (JavaScript / Typescript) -* @paperless-ngx/ci-cd (GitHub Actions / Deployment) -* @paperless-ngx/issues (Issue triage) -* @paperless-ngx/test (General testing for larger PRs) +- @paperless-ngx/backend (Python / django) +- @paperless-ngx/frontend (JavaScript / Typescript) +- @paperless-ngx/ci-cd (GitHub Actions / Deployment) +- @paperless-ngx/issues (Issue triage) +- @paperless-ngx/test (General testing for larger PRs) ## Permissions All team members are notified when mentioned or assigned to a relevant issue or pull request. Additionally, each team has slightly different access to paperless-ngx: -* The **test** team has no special permissions. -* The **issues** team has `triage` access. This means they can organize issues and pull requests. -* The **backend**, **frontend**, and **ci-cd** teams have `write` access. This means they can approve PRs and push code, containers, releases, and more. +- The **test** team has no special permissions. +- The **issues** team has `triage` access. This means they can organize issues and pull requests. +- The **backend**, **frontend**, and **ci-cd** teams have `write` access. This means they can approve PRs and push code, containers, releases, and more. ## Joining