Skip to content

Commit 39b0100

Browse files
committed
feat: include contribution requirements.
1 parent 880a73c commit 39b0100

30 files changed

+60
-0
lines changed

CONTRIBUTING.rst

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
Contributions
2+
=============
3+
Contributions to this open-source project are welcome and always appreciated! Every line of code helps
4+
us ensure a better developed project to users. We will always credit those who help out.
5+
6+
New to contributing
7+
-------------------
8+
If you're new to contributing towards this project, we highly recommend starting off with installing
9+
the library off of pip:
10+
11+
.. code-block:: bash
12+
13+
pip install -U discord-py-interactions
14+
15+
Once you have the library installed in Python, you are able to instantiate and run a basic bot
16+
with a logging level that is set for debugging purposes. This is recommend in order to make it easier
17+
for us to log certain events and procedures internally that may happen before, during or after an
18+
error may be produced:
19+
20+
.. code-block:: python
21+
:linenos:
22+
23+
import interactions
24+
from logging import DEBUG
25+
26+
bot = interactions.Client(token="...", log_level=DEBUG) # you can also use -1.
27+
28+
bot.start()
29+
30+
Since we are an open-source project that unofficially supports the Discord API, we also respect
31+
the `Code of Conduct`_ from their documentation.
32+
33+
Where to start
34+
--------------
35+
Our contributions start with an **Issue**. The issue should explain what the problem you're having is.
36+
Issues are our way and methodology of tracking bugs that may be occuring with this library. In order
37+
to create create in relevance to the issue, you start a **Pull Request**. Linking the issue in this
38+
(known as a PR) allows us to easily identify what bugs have been correlated with the code requesting
39+
to be changed in the source, and allow other developers to contribute where needed.
40+
41+
When a PR is made, you **must** be targeting the ``unstable`` branch. This is our development branch
42+
that we use whenever we're working on any bugfixing, breaking changes and/or overall new features. Our
43+
development workflow for changes is from this branch to ``stable``, and then from there to a release.
44+
45+
Pull Request specifications
46+
***************************
47+
A pull request should adhere to these following requirements:
48+
49+
- Each git commit made on your forked project should use `conventional commits`_.
50+
- The pull request should always be up-to-date with ``unstable``.
51+
52+
Recognizing contributors
53+
------------------------
54+
When a PR is successfully merged into one of the development branches, the GitHub user will automatically
55+
be added to the contributor list of the repository. Additionally, we also provide a role in our support
56+
server for contributors. (You will be notified if you are eligible for this.) The git commit history on a
57+
file will also subsequently be updated by GitHub to include your user signature.
58+
59+
.. _Code of Conduct: https://github.com/discord/discord-api-docs/blob/master/CODE_OF_CONDUCT.md
60+
.. _conventional commits: https://www.conventionalcommits.org/en/v1.0.0/
439 Bytes
Binary file not shown.
439 Bytes
Binary file not shown.
439 Bytes
Binary file not shown.
439 Bytes
Binary file not shown.
439 Bytes
Binary file not shown.
439 Bytes
Binary file not shown.

docs/locale/de/LC_MESSAGES/api.mo

439 Bytes
Binary file not shown.
439 Bytes
Binary file not shown.
439 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)