diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..7833f027 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,96 @@ +Contributing to pyCA +==================== + +As an open source project, pyCA welcomes contributions of many forms. +Examples of contributions include: + +- Code patches +- Documentation improvements +- Bug reports and patch reviews + +If you need more information about how to create a fork or a pull request, +check out this `first contributions guide`_ or simply ask questions. + + +Being Pragmatic +--------------- + +For every rule, there is an exception. +If you find that there is a good reason one of the following rules does not apply to you, +please bring it up and explain why. +We like to be pragmatic if necessary instead of blindly follow rules. + + +Provide Necessary Information +----------------------------- + +If you provide a patch, please also provide an explanation of the reasoning behind this patch. +It is much easier to understand and review code if you know its intention upfront. +If a pull request relates to an existing issue, please also link that issue. + +If you want to make us happy, please also provide this reasoning as part of your git commit messages. + + +Tests +----- + +PyCA comes with a set of tests which are run automatically on our CI system. +Passing these tests is a requirement for all contributions. + +If the CI tests on your pull request fail and you are sure it is not caused by your patch, please complain. +Errors happen and we can easily trigger a new build. +Your patch cannot be merged without these tests passing. + + +Documentation +------------- + +If necessary, say for instance you modify the API, +please also provide the documentation for your change as part of your pull request. +Once a pull request is merged, the documentation should match that code. + + +Reviews +------- + +A reviewer will be assigned to your pull request to ensure that there are no issues. +Once everything is fine, the reviewer will merge the pull request. +Please communicate with the reviewer to address any issues. + +Please remember that reviewers are only human as well. + + +Merging +------- + +We prefer to `rebase and merge pull requests`_ if the contribution has a sane commit history +or to `squash and merge your pull request commits`_ if they have not. +This is meant to keep the overall commit history as clean as possible. +If you prefer a specific merge mode for any reason, please indicate that on the pull request. + + +Checklist +--------- + +- Pull request `closes an accompanying issue`_ if one exists +- Pull request has a proper title and description +- Appropriate documentation is included +- Code passes automatic tests +- The pull request has a clean commit history +- Commits have a `proper commit message`_ (title and body) + + +Project Management +------------------ + +This project was started and is watched over by `Lars Kiesow`_. +Decisions are usually made as part of the community discussion and contributions are highly appreciated. +But in case of conflicts, the project lead may make the final decision. + + +.. _first contributions guide: https://github.com/firstcontributions/first-contributions#first-contributions +.. _rebase and merge pull requests: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges#rebase-and-merge-your-pull-request-commits +.. _squash and merge your pull request commits: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges#squash-and-merge-your-pull-request-commits +.. _closes an accompanying issue: https://help.github.com/en/articles/closing-issues-using-keywords +.. _proper commit message: https://chris.beams.io/posts/git-commit/ +.. _Lars Kiesow: https://lkiesow.de diff --git a/readme.rst b/README.rst similarity index 100% rename from readme.rst rename to README.rst diff --git a/SECURITY.rst b/SECURITY.rst new file mode 100644 index 00000000..923ec226 --- /dev/null +++ b/SECURITY.rst @@ -0,0 +1,15 @@ +Security Policy +=============== + +Supported Versions +------------------ + +We support only the latest version of this project. + + +Reporting a Vulnerability +------------------------- + +If you find a security vulnerability, +please report it by sending a mail to security@lkiesow.de. +We will discuss the problem internally and, if necessary, release a patched version as soon as possible. diff --git a/docs/readme.rst b/docs/readme.rst index 52d759e3..9cac7c48 100644 --- a/docs/readme.rst +++ b/docs/readme.rst @@ -12,16 +12,12 @@ This section contains installation guides for specific operating systems or Linu - `CentOS 8 `_ - `Fedora `_ -Developer Installation - -- `General Linux `_ - Configuration ------------- Most configuration documentation is contained in the `documentation file <../etc/pyca.conf>`_. -This sections just contains a few additional notes to convei ideas behing some specific configuration settings. +This sections just contains a few additional notes to convey ideas behind some specific configuration settings. - `System Service (Systemd) `_ - `Authentication Modes `_ @@ -30,8 +26,8 @@ This sections just contains a few additional notes to convei ideas behing some s - `Backup Capture Agent `_ -Recording commands ---------------- +Recording Commands +------------------ - `FFmpeg `_ - `Raspberry Pi Camera Module `_ @@ -44,4 +40,7 @@ API Developer Information --------------------- +- `Development Installation `_ +- `Contributing to pyCA <../CONTRIBUTING.rst>`_ +- `Reporting Security Issues <../SECURITY.rst>`_ - `Upload to PyPI `_