Skip to content

Commit 2fe1c77

Browse files
committed
Add a CONTRIBUTING.md doc
1 parent 86f85e4 commit 2fe1c77

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ support Python 2.6 and above.
2020
[colorama] is included as a required dependency and initialised when using
2121
colorlog on Windows.
2222

23-
This library is almost a decade old and supported a wide set of Python versions
23+
This library is over a decade old and supported a wide set of Python versions
2424
for most of its life, which has made it a difficult library to add new features
2525
to. colorlog 6 may break backwards compatibility so that newer features
2626
can be added more easily, but may still not accept all changes or feature

docs/CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing to colorlog
2+
3+
## New features
4+
5+
Open a thread in the "[Discussions]" section of the GitHub repository before doing any significant work on a new feature. This library is over a decade old, and my priority in maintaining it is stability rather than features. See the [Status](../README.md#Status]) section of the README file for more information.
6+
7+
## Bugfixes
8+
9+
_Please_ provide a simple way to reproduce any bug you encounter when opening an issue. It's very common for bugs to be reported for this library that are actually caused by the calling code or another library being used alongside it.
10+
11+
## Pull requests
12+
13+
Open pull requests against the `main` branch.
14+
15+
Make sure your changes pass the test suite, which runs tests against most recent versions of Python 3 and checks the `black` formatter makes no changes.
16+
* You can run tests locally with `tox` if you have suitable versions of Python 3 installed...
17+
* ...or use the GitHub Actions pipeline which will run automatically once you open a pull request.
18+
19+
[Discussions]: https://github.com/borntyping/python-colorlog/discussions

0 commit comments

Comments
 (0)