We would love for you to contribute to CPL and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:
-
Feature Request
+
Feature Request
You can request a new feature by submitting an issue to our Gitea Repository. If you would like to implement a new feature, please consider the size of the change in order to determine the right steps to proceed:
For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This process allows us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
Note: Adding a new topic to the documentation, or significantly re-writing a topic, counts as a major feature.
Small Features can be crafted and directly submitted as a Pull Request.
-
Submission Guidelines
+
Submission Guidelines
-
Submitting an Issue
+
Submitting an Issue
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we require that you provide a minimal reproduction. Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.
A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.
@@ -98,7 +187,7 @@
Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don’t hear back from you, we are going to close an issue that doesn’t have enough info to be reproduced.
-
Submitting a Pull Request
+
Submitting a Pull Request
Before you submit your Pull Request (PR) consider the following guidelines:
Search the repository for an open or closed PR that relates to your submission. You don’t want to duplicate existing efforts.
@@ -128,10 +217,10 @@
-
Reviewing a Pull Request
+
Reviewing a Pull Request
The sh-edraft.de team reserves the right not to accept pull requests from community members who haven’t been good citizens of the community. Such behavior includes not following the CPL coding rules and applies within or outside of CPL managed channels.
-
Addressing review feedback
+
Addressing review feedback
If we ask for changes via code reviews then:
Make the required updates to the code.
@@ -147,7 +236,7 @@ git push
-
Coding Rules
+
Coding Rules
To ensure consistency throughout the source code, keep these rules in mind as you are working:
+
+ © Copyright 2021, Sven Heidemann.
- Built with Sphinx using a
+
+
.