From 54ba0fdeea166b880d8e930bc65cf4d1b479add2 Mon Sep 17 00:00:00 2001 From: Harald Nezbeda Date: Fri, 14 Oct 2022 16:42:18 +0200 Subject: [PATCH] Add contribution guide and requirements for local development --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ requirements.txt | 6 ++++++ 2 files changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 requirements.txt diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..21dffcf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Guidance on how to contribute + +> By submitting a pull request or filing a bug, issue, or feature request, +> you are agreeing to comply with this waiver of copyright interest. +> Details can be found in our [LICENSE](LICENSE). + + +There are two primary ways to help: + - Using the issue tracker, and + - Changing the code-base. + + +## Using the issue tracker + +Use the issue tracker to suggest feature requests, report bugs, and ask questions. +This is also a great way to connect with the developers of the project as well +as others who are interested in this solution. + +Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in +the issue that you will take on that effort, then follow the _Changing the code-base_ +guidance below. + + +## Changing the code-base + +Generally speaking, you should fork this repository, make changes in your +own fork, and then submit a pull request. All new code should have associated +unit tests that validate implemented features and the presence or lack of defects. +Additionally, the code should follow any stylistic and architectural guidelines +prescribed by the project. In the absence of such guidelines, mimic the styles +and patterns in the existing code-base. + +### Contribution guidelines + - Your code should follow PEP 8 -- Style Guide for Python Code + - Your changes should be covered by unit-tests \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..b174f8b --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +# Package and package dependencies +-e . + +# Development dependencies +django>=3.2,<4 +djangorestframework>=3.13,<4