forked from Pycord-Development/pycord
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request Pycord-Development#378 from Aiko-IT-Systems/multip…
…le-things Add DCO & Contributing
- Loading branch information
Showing
2 changed files
with
81 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Contributing to Pycord | ||
We're really happy to accept contributions. However we also ask that you follow several rules when doing so. | ||
|
||
# Proper base | ||
When opening a PR, please make sure your branch targets the latest release branch, in this case it would be `master`. Also make sure your branch is even with the target branch, to avoid unnecessary surprises. | ||
|
||
# Versioning | ||
We follow [SemVer](https://semver.org/) versioning when it comes to pushing stable releases. Ideally, this means you should only be creating PRs for `patch` and `minor` changes. If you wish to introduce a `major` (breaking) change, please discuss it beforehand so we can determine how to integrate it into our next major version. If this involves removing a public facing property/method, mark it with obsolete instead on the latest release branch. | ||
|
||
# Proper titles | ||
When opening issues, make sure the title reflects the purpose of the issue or the pull request. Prefer past tense, and | ||
be brief. Further description belongs inside the issue or PR. | ||
|
||
# Descriptive changes | ||
We require the commits describe the change made. It can be a short description. If you fixed or resolved an open issue, | ||
please reference it by using the # notation. | ||
|
||
Examples of good commit messages: | ||
|
||
* `Fixed a potential memory leak with cache entities. Fixes #142.` | ||
* `Implemented new command extension. Resolves #169.` | ||
* `Changed message cache behaviour. It's now global instead of per-channel.` | ||
* `Fixed a potential NRE.` | ||
* ``` | ||
Changed message cache behaviour: | ||
- Messages are now stored globally. | ||
- Cache now deletes messages when they are deleted from discord. | ||
- Cache itself is now a ring buffer. | ||
``` | ||
|
||
# Code changes | ||
One of our requirements is that all code change commits must build successfully. This is verified by our CI. You can view its summary by visiting it from the checks section on | ||
the PR overview page. | ||
|
||
PRs that do not build will not be accepted. | ||
|
||
Furthermore we require that methods you implement on Discord entities have a reflection in the Discord API. | ||
|
||
In the event your code change is a style change, doc change, or otherwise does not change how the code works, tag | ||
the commit with `[ci skip]`. | ||
|
||
# Non-code changes | ||
In the event you change something outside of code (i.e. a meta-change or documentation), you must tag your commit with | ||
`[ci skip]`. |
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 |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Developer Certificate of Origin (DCO) | ||
``` | ||
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. | ||
Developer's Certificate of Origin 1.1 | ||
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. | ||
``` |