-
-
Notifications
You must be signed in to change notification settings - Fork 165
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: make the PR template less bloaty
- Loading branch information
1 parent
2a2d37d
commit 864022c
Showing
2 changed files
with
45 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,8 @@ | ||
# Contributing | ||
|
||
When contributing to this repository, please do not feel intimidated! We welcome PRs from developers of all levels of experience and we were all new once. | ||
|
||
## Pull Request Process | ||
|
||
1. Pull requests should be made against the `dev` branch. | ||
2. Ensure that the changed library can be built on your target system. Do not introduce any platform- | ||
specific code. | ||
3. Ensure that all methods and functions you add are **fully documented** using doxygen style comments. | ||
4. Test your commit! Make a simple single-file test bot to demonstrate the change, include this with the PR | ||
as an attached file on a comment, so we can test and see how it works. | ||
5. Ensure that you do not break any existing API calls without discussing on Discord first! | ||
6. Be sure to follow the coding style guide (if you are not sure, match the code style of existing files | ||
including indent style etc). | ||
7. Your PR must pass the CI actions before being allowed to be merged. Our PR actions check that the | ||
build will compile on various platforms before release and makes precompiled versions of the library. | ||
8. Automated changes e.g. via grammarly or a static analysis tool will not usually be accepted into the code without proper thought out justification (by a human being, not an AI or an App) as to why the changes are required. Generally a PR should do more than fix a single spelling error for example as this just takes precious time for something which could be resolved a direct commit to the dev branch. | ||
9. All contributors agree to the terms of the DCO (Developer Certificate of Origin) as listed below. This document is to protect you, and us, from any legal issues by making clear that code you contribute to this project becomes part the D++ project. | ||
|
||
``` | ||
Version 1.1 | ||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
Everyone is permitted to copy and distribute verbatim copies of this | ||
license document, but changing it is not allowed. | ||
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 open source license | ||
indicated in the file; 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 same open source license (unless I am | ||
permitted to submit under a different license), as indicated | ||
in the file; 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, including my sign-off) is | ||
maintained indefinitely and may be redistributed consistent with | ||
this project or the open source license(s) involved. | ||
``` | ||
|
||
- [ ] My pull request is made against the `dev` branch. | ||
- [ ] I have ensured that the changed library can be built on your target system. I did not introduce any platform-specific code. | ||
- [ ] I have ensured that all methods and functions are **fully documented** using doxygen style comments. | ||
- [ ] I tested my commits, by adding a test case to the unit tests if needed | ||
- [ ] I have ensured that I did not break any existing API calls. | ||
- [ ] My code follows the [coding style guide](https://dpp.dev/coding-standards.html) (if you are not sure, match the code style of existing files including indent style etc). | ||
- [ ] I have not built my pull request using AI, a static analysis tool or similar without any human oversight. Where I have generated this pull request using a tool, I have justified why this is needed. | ||
- [ ] I agree to the terms of the [DCO (Developer Certificate of Origin)]((https://dpp.dev/coding-standards.html)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters