Skip to content

Commit 4c58159

Browse files
committed
Add DCO & Contributing
1 parent d33d03a commit 4c58159

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to Pycord
2+
We're really happy to accept contributions. However we also ask that you follow several rules when doing so.
3+
4+
# Proper base
5+
When opening a PR, please make sure your branch targets the latest release branch, in this case it would be `main`. Also make sure your branch is even with the target branch, to avoid unnecessary surprises.
6+
7+
# Versioning
8+
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 the `Obsolete` attribute instead on the latest release branch.
9+
10+
# Proper titles
11+
When opening issues, make sure the title reflects the purpose of the issue or the pull request. Prefer past tense, and
12+
be brief. Further description belongs inside the issue or PR.
13+
14+
# Descriptive changes
15+
We require the commits describe the change made. It can be a short description. If you fixed or resolved an open issue,
16+
please reference it by using the # notation.
17+
18+
Examples of good commit messages:
19+
20+
* `Fixed a potential memory leak with cache entities. Fixes #142.`
21+
* `Implemented new command extension. Resolves #169.`
22+
* `Changed message cache behaviour. It's now global instead of per-channel.`
23+
* `Fixed a potential NRE.`
24+
* ```
25+
Changed message cache behaviour:
26+
27+
- Messages are now stored globally.
28+
- Cache now deletes messages when they are deleted from discord.
29+
- Cache itself is now a ring buffer.
30+
```
31+
32+
# Code changes
33+
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
34+
the PR overview page.
35+
36+
PRs that do not build will not be accepted.
37+
38+
Furthermore we require that methods you implement on Discord entities have a reflection in the Discord API.
39+
40+
In the event your code change is a style change, doc change, or otherwise does not change how the code works, tag
41+
the commit with `[ci skip]`.
42+
43+
# Non-code changes
44+
In the event you change something outside of code (i.e. a meta-change or documentation), you must tag your commit with
45+
`[ci skip]`.

DEVELOPER_CERTIFICATE_OF_ORIGIN.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Developer Certificate of Origin (DCO)
2+
```
3+
Version 1.1
4+
5+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
6+
7+
Everyone is permitted to copy and distribute verbatim copies of this
8+
license document, but changing it is not allowed.
9+
10+
11+
Developer's Certificate of Origin 1.1
12+
13+
By making a contribution to this project, I certify that:
14+
15+
(a) The contribution was created in whole or in part by me and I
16+
have the right to submit it under the open source license
17+
indicated in the file; or
18+
19+
(b) The contribution is based upon previous work that, to the best
20+
of my knowledge, is covered under an appropriate open source
21+
license and I have the right under that license to submit that
22+
work with modifications, whether created in whole or in part
23+
by me, under the same open source license (unless I am
24+
permitted to submit under a different license), as indicated
25+
in the file; or
26+
27+
(c) The contribution was provided directly to me by some other
28+
person who certified (a), (b) or (c) and I have not modified
29+
it.
30+
31+
(d) I understand and agree that this project and the contribution
32+
are public and that a record of the contribution (including all
33+
personal information I submit with it, including my sign-off) is
34+
maintained indefinitely and may be redistributed consistent with
35+
this project or the open source license(s) involved.
36+
```

0 commit comments

Comments
 (0)