Skip to content

Commit 14af154

Browse files
committed
Add some guidelines for contributing
1 parent 53b21d7 commit 14af154

2 files changed

Lines changed: 71 additions & 0 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing to Python-valve #####
2+
3+
Thank you for wanting to contribute to Python-valve. Whether you're
4+
reporting an issue, submitting a pull request or anything else, please
5+
be aware of this project's [Code of Conduct](../CODE_OF_CONDUCT.md).
6+
To summarise: *be polite, be respectful, be empathetic*.
7+
8+
Additionally, it is expected that English is used in all issues, pull
9+
requests, code, commit messages, etc.. If English is not your first
10+
language, your best effort attempt will be appreciated and treated with
11+
the necessary patience.
12+
13+
Finally, whether it's a bug report, pull request or a feature requests.
14+
Please check to make sure that it is not a duplicate of an existing
15+
discussion. If it is a duplicate, add to the existing discussion instead.
16+
17+
18+
## Bug Reports ####
19+
20+
When reporting issues with Python-valve, please follow the template that
21+
is provided to the best of your ability. Sometimes the scope of the issue
22+
means that the template isn't entirely relevant. In these cases it's cool
23+
to ignore the irrelevant parts. :+1:
24+
25+
26+
## Pull Requests ####
27+
28+
Always feel free to submit pull requests. When doing so, please include,
29+
at minimum, a short description of what the pull request is for. If the
30+
pull request addresses a specific issue, please refer back to that issue.
31+
However, entirely speculative pull requests are also appreciated.
32+
33+
For more complex pull requests, please be more elaborate in your
34+
description.
35+
36+
A few criteria must be met before a pull request will be accepted:
37+
38+
- When adding **new code**, it *must* have **accompanying tests**. It
39+
*must* also **pass all linting checks**.
40+
- Ideally **all tests must pass**, on all platforms. It's okay to modify
41+
tests. It *might* be okay to skip tests or mark them as failing. If in
42+
doubt, mention it in the pull request description or comments.
43+
- If intentionally making non-backwards compatible, **breaking changes**,
44+
you **must include a justification**. Ideally, please also demonstrate
45+
that you've thought through the implications.
46+
- If modifying or adding to the public API, the corresponding
47+
**documentation must be updated**.
48+
49+
Everyone deserves credit for their work. Therefore, in addition
50+
to the above requirements, you may wish to add yourself to the formal
51+
[list of contributors](../CONTRIBUTORS.md), with a very brief description
52+
of your contribution(s). This is entirely optional though.
53+
54+
55+
## Ideas and Feature Requests ####
56+
57+
It's completely fine to open an issue for ideas and feature requests.
58+
When creating such issues, please be as descriptive as possible and
59+
include a concrete use case.
60+
61+
62+
## If in doubt ... ####
63+
64+
[Open an issue and ask](https://github.com/serverstf/python-valve/issues/new)!

CONTRIBUTORS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Python-valve Contributors ####
2+
3+
- **[Oliver Ainsworth](https://github.com/Holiverh)**
4+
- Original author and maintainer.
5+
6+
**[Unabridged list of contributors](
7+
https://github.com/serverstf/python-valve/graphs/contributors)**.

0 commit comments

Comments
 (0)