Skip to content

Commit

Permalink
Add a CONTRIBUTING.md doc
Browse files Browse the repository at this point in the history
  • Loading branch information
borntyping committed Jan 26, 2024
1 parent 86f85e4 commit 2fe1c77
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ support Python 2.6 and above.
[colorama] is included as a required dependency and initialised when using
colorlog on Windows.

This library is almost a decade old and supported a wide set of Python versions
This library is over a decade old and supported a wide set of Python versions
for most of its life, which has made it a difficult library to add new features
to. colorlog 6 may break backwards compatibility so that newer features
can be added more easily, but may still not accept all changes or feature
Expand Down
19 changes: 19 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contributing to colorlog

## New features

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.

## Bugfixes

_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.

## Pull requests

Open pull requests against the `main` branch.

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.
* You can run tests locally with `tox` if you have suitable versions of Python 3 installed...
* ...or use the GitHub Actions pipeline which will run automatically once you open a pull request.

[Discussions]: https://github.com/borntyping/python-colorlog/discussions

0 comments on commit 2fe1c77

Please sign in to comment.