Any contribution helps EMS-ESP get better for the entire community!
Everybody is welcome and invited to contribute to the EMS-ESP Project by:
- providing Pull Requests (Features, Fixes, suggestions)
- testing new released features and report issues on your EMS equipment
- contributing to missing documentation
This document describes rules that are in effect for this repository, meant for handling issues by contributors in the issue tracker and PRs.
- Opening an issue means that a problem exists in the code and should be addressed by the project contributors.
- When opening an issue, it is required to fill out the presented template. The requested information is important! If the template is ignored or insufficient info about the issue is provided, the issue may be closed.
- Questions of type "How do I..." or "Can you please help me with..." or "Can EMS-ESP do..." are better directed to the support channel on Discord.
- Issues about topics already handled in the documentation will be closed in a similar manner.
- Issues for unmerged PRs will be closed. If there is an issue with a PR, the explanation should be added to the PR itself.
- Issues with accompanied investigation that shows the root of the problem should be given priority.
- Duplicate issues will be closed.
- Any contributor to the project can participate in the triaging process, if he/she chooses to do so.
- An issue that needs to be closed, either due to not complying with this policy, or for other reasons, should be closed by a contributor.
- Issues that are accepted should be marked with appropriate labels.
- Issues that could impact functionality for many users should be considered severe.
- Issues caused by the SDK or chip should not be marked severe, as there usually isn’t much to be done. Common sense should be applied when deciding. Such issues should be documented in the documentation, for reference by users.
- Issues with feature requests should be discussed for viability/desirability.
- Feature requests or changes that are meant to address a very specific/limited use case, especially if at the expense of increased code complexity, may be denied, or may be required to be redesigned, generalized, or simplified.
- Feature requests that are not accompanied by a PR:
- could be closed immediately (denied).
- could be closed after some predetermined period of time (left as candidate for somebody to pick up).
- In some cases, feedback may be requested from the issue reporter, either as additional info for clarification, additional testing, or other. If no feedback is provided, the issue may be closed by a contributor or after 40 days by the STALE bot.
A Pull Request (PR) is the process where code modifications are managed in GitHub.
The process is straight-forward.
- Read How to get faster PR reviews by Kubernetes (but skip step 0)
- Fork the EMS-ESP Repository git repository.
- Write/Change the code in your Fork for a new feature, bug fix, new sensor, optimization, etc.
- Ensure tests work.
- Create a Pull Request against the dev branch of EMS-ESP.
- All pull requests must be done against the dev branch.
- Make sure code is formatting per the
.clang-format. - Make sure any new code is clearly commented explaining what the function/logic does.
- Only relevant files should be touched (Also beware if your editor has auto-formatting feature enabled).
- Only one feature/fix should be added per PR.
- PRs that don't compile (fail in CI Tests) or cause coding errors will not be merged. Please fix the issue. Same goes for PRs that are raised against older commit in dev - you might need to rebase and resolve conflicts.
- All pull requests should undergo peer review by at least one contributor other than the creator, excepts for the owner.
- All pull requests should consider updates to the documentation.
- Pull requests that address an outstanding issue, particularly an issue deemed to be severe, should be given priority.
- If a PR is accepted, then it should undergo review and updated based on the feedback provided, then merged.
- By submitting a PR, it is needed to use the provided PR template and check all boxes, performing the required tasks and accepting the CLA.
- Pull requests that don't meet the above will be denied and closed.
See how a minor change to your commit message style can make you a better programmer.
Format: <type>(<scope>): <subject>
<scope> is optional
feat: add hat wobble
^--^ ^------------^
| |
| +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.
More Examples:
feat: (new feature for the user, not a new feature for build script)fix: (bug fix for the user, not a fix to a build script)docs: (changes to the documentation)style: (formatting, missing semi colons, etc; no production code change)refactor: (refactoring production code, eg. renaming a variable)test: (adding missing tests, refactoring tests; no production code change)chore: (updating grunt tasks etc; no production code change)
References:
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the GPL-3.0 license; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the GPL-3.0 license; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it) is maintained indefinitely
and may be redistributed consistent with this project or the open
source license(s) involved.
This Contributor License Agreement (CLA) was adopted on April 1st, 2019.
The text of this license is available under the Creative Commons Attribution-ShareAlike 3.0 Unported License. It is based on the Linux Developer Certificate Of Origin, but is modified to explicitly use the GPL-3.0 license and not mention sign-off (due to GitHub.com keeps an historial, with your user name, of PRs' commits and all editions on PR's comments).
Why a CLA ?
"A Contributor Licence Agreement (CLA) is strongly recommended when accepting third party contributions to an open development project, such as an open source software project. In order to redistribute contributions, it is necessary to ensure that the project has the necessary rights to do so. A Contributor Licence Agreement is a lightweight agreement, signed by the copyright holder, that grants the necessary rights for the contribution to be redistributed as part of the project." OSS Watch
A CLA is a legal document in which you state you are entitled to contribute the code/documentation/translation to the project you’re contributing to and that you are willing to have it used in distributions and derivative works. This means that should there be any kind of legal issue in the future as to the origins and ownership of any particular piece of code, then that project has the necessary forms on file from the contributor(s) saying they were permitted to make this contribution.
CLA is a safety because it also ensures that once you have provided a contribution, you cannot try to withdraw permission for its use at a later date. People can therefore use that software, confident that they will not be asked to stop using pieces of the code at a later date.
A license grants "outbound" rights to the user of project.
A CLA enables a contributor to grant "inbound" rights to a project.