|
| 1 | +# Contributing to github-docs-cookiecutter |
| 2 | + |
| 3 | +You want to contribute to github-docs-cookiecutter? Welcome! Please read this document to understand what you can do: |
| 4 | + |
| 5 | +* [Help Others](#help-others) |
| 6 | +* [Analyze Issues](#analyze-issues) |
| 7 | +* [Report an Issue](#report-an-issue) |
| 8 | +* [Contribute Code](#contribute-code) |
| 9 | + |
| 10 | +## Help Others |
| 11 | + |
| 12 | +You can help github-docs-cookiecutter by helping others who use it and need support. |
| 13 | + |
| 14 | +## Analyze Issues |
| 15 | + |
| 16 | +Analyzing issue reports can be a lot of effort. Any help is welcome! |
| 17 | +Go to [the GitHub issue tracker](https://github.com/jcook3701/github-docs-cookiecutter/issues?state=open) and find an open issue which needs additional work or a bugfix (e.g. issues labeled with "help wanted" or "bug"). |
| 18 | + |
| 19 | +Additional work could include any further information, or a gist, or it might be a hint that helps understanding the issue. Maybe you can even find and [contribute](#contribute-code) a bugfix? |
| 20 | + |
| 21 | +## Report an Issue |
| 22 | + |
| 23 | +If you find a bug - behavior of github-docs-cookiecutter code contradicting your expectation - you are welcome to report it. |
| 24 | +We can only handle well-reported, actual bugs, so please follow the guidelines below. |
| 25 | + |
| 26 | +Once you have familiarized with the guidelines, you can go to the [GitHub issue tracker for github-docs-cookiecutter](https://github.com/jcook3701/github-docs-cookiecutter/issues/new) to report the issue. |
| 27 | + |
| 28 | +### Quick Checklist for Bug Reports |
| 29 | + |
| 30 | +Issue report checklist: |
| 31 | +* Real, current bug |
| 32 | +* No duplicate |
| 33 | +* Reproducible |
| 34 | +* Good summary |
| 35 | +* Well-documented |
| 36 | +* Minimal example |
| 37 | +<!-- * Use the [template](ISSUE_TEMPLATE.md) --> |
| 38 | + |
| 39 | +### Issue handling process |
| 40 | + |
| 41 | +When an issue is reported, a committer will look at it and either confirm it as a real issue, close it if it is not an issue, or ask for more details. |
| 42 | + |
| 43 | +An issue that is about a real bug is closed as soon as the fix is committed. |
| 44 | + |
| 45 | +### Reporting Security Issues |
| 46 | + |
| 47 | +If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. |
| 48 | +Please send the related information to <jcook3701+github-docs-cookiecutter@gmail.com>. |
| 49 | + |
| 50 | +### Usage of Labels |
| 51 | + |
| 52 | +GitHub offers labels to categorize issues. We defined the following labels so far: |
| 53 | + |
| 54 | +Labels for issue categories: |
| 55 | +* bug: this issue is a bug in the code |
| 56 | +* feature: this issue is a request for a new functionality or an enhancement request |
| 57 | +* design: this issue relates to the UI or UX design of the tool |
| 58 | + |
| 59 | +Status of open issues: |
| 60 | +* help wanted: the feature request is approved and you are invited to contribute |
| 61 | + |
| 62 | +Status/resolution of closed issues: |
| 63 | +* wontfix: while acknowledged to be an issue, a fix cannot or will not be provided |
| 64 | + |
| 65 | +The labels can only be set and modified by committers. |
| 66 | + |
| 67 | +### Issue Reporting Disclaimer |
| 68 | + |
| 69 | +We want to improve the quality of github-docs-cookiecutter and good bug reports are welcome! But our capacity is limited, thus we reserve the right to close or to not process insufficient bug reports in favor of those which are very cleanly documented and easy to reproduce. Even though we would like to solve each well-documented issue, there is always the chance that it will not happen - remember: github-docs-cookiecutter is Open Source and comes without warranty. |
| 70 | + |
| 71 | +Bug report analysis support is very welcome! (e.g. pre-analysis or proposing solutions) |
| 72 | + |
| 73 | +## Contribute Code |
| 74 | + |
| 75 | +You are welcome to contribute code to github-docs-cookiecutter in order to fix bugs or to implement new features. |
| 76 | + |
| 77 | +There are three important things to know: |
| 78 | +1. You must be aware that you need to submit [Developer Certificate of Origin](https://developercertificate.org/) in order for your contribution to be accepted. This is common practice in all major Open Source projects. |
| 79 | +2. There are **several requirements regarding code style, quality, and product standards** which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines. |
| 80 | +3. **Not all proposed contributions can be accepted**. Some features may e.g. just fit a third-party add-on better. The code must fit the overall direction of github-docs-cookiecutter and really improve it. The more effort you invest, the better you should clarify in advance whether the contribution fits: the best way would be to just open an issue to discuss the feature you plan to implement (make it clear you intend to contribute). |
| 81 | + |
| 82 | +## Developer Certificate of Origin (DCO) |
| 83 | + |
| 84 | +Due to legal reasons, contributors will be asked to accept a DCO before they submit the first pull request to this projects, this happens in an automated fashion during the submission process. We use [the standard DCO text of the Linux Foundation](https://developercertificate.org/). |
| 85 | + |
| 86 | +### Contribution Content Guidelines |
| 87 | + |
| 88 | +These are some of the rules we try to follow: |
| 89 | +* Apply a clean coding style adapted to the surrounding code, even though we are aware the existing code is not fully clean |
| 90 | +* Use (4)spaces for indentation (except if the modified file consistently uses tabs) |
| 91 | +* Use variable naming conventions like in the other files you are seeing (underscore) |
| 92 | +* No console.log() - use logging service |
| 93 | +* Run all ci/cd code checks and make sure they succeed |
| 94 | +* Comment your code where it gets non-trivial |
| 95 | +* Keep an eye on performance and memory consumption, properly destroy objects when not used anymore |
| 96 | +* Write a unit test |
| 97 | +* Do not do any incompatible changes, especially do not modify the name or behavior of public API methods or properties |
| 98 | + |
| 99 | +### How to contribute - the Process |
| 100 | + |
| 101 | +1. Make sure the change would be welcome (e.g. a bugfix or a useful feature); best do so by proposing it in a GitHub issue |
| 102 | +2. Create a branch forking the github-docs-cookiecutter repository and do your change |
| 103 | +3. Commit and push your changes on that branch |
| 104 | +4. In the commit message |
| 105 | + * Describe the problem you fix with this change. |
| 106 | + * Describe the effect that this change has from a user's point of view. App crashes and lockups are pretty convincing for example, but not all bugs are that obvious and should be mentioned in the text. |
| 107 | + * Describe the technical details of what you changed. It is important to describe the change in a most understandable way so the reviewer is able to verify that the code is behaving as you intend it to. |
| 108 | +5. If your change fixes an issue reported at GitHub, add the following line to the commit message: |
| 109 | + * ```Fixes #(issueNumber)``` |
| 110 | + * Do NOT add a colon after "Fixes" - this prevents automatic closing. |
| 111 | +6. Create a Pull Request |
| 112 | +7. Follow the link posted by the github-docs-cookiecutter to your pull request and accept it, as described in detail above. |
| 113 | +8. Wait for our code review and approval, possibly enhancing your change on request |
| 114 | + * Note that the github-docs-cookiecutter developers also have their regular duties, so depending on the required effort for reviewing, testing and clarification this may take a while |
| 115 | +9. Once the change has been approved we will inform you in a comment |
| 116 | +10. We will close the pull request, feel free to delete the now obsolete branch |
0 commit comments