Skip to content

Commit 2c3603e

Browse files
authored
👥 Create CONTRIBUTING.md
1 parent 0cdfed2 commit 2c3603e

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Thanks heaps for being interested in contributing to python-bibtexparser.
2+
3+
We are always looking for people to improve the library. Contributions include, but are not limited to:
4+
5+
1. Opening well described issues for bugs or feature requests.
6+
2. Providing bugfixing PRs
7+
3. Implementing any of the issues or continuing any of the PRs labelled with `needs help` or `good first issue`.
8+
9+
Some guidelines:
10+
11+
1. Be nice! Were all doing this in our free time; no one is obligated to do anything.
12+
2. Add sufficient tests to your PRs
13+
3. Document your code.
14+
4. Don't hesitate to ask questions.
15+
16+
Also note that there are currently two independent "default" branches:
17+
First, `master`, where we maintain a stable `v1.x` and where we merge almost only backwards-compatible bugfixes.
18+
Second, `v2` where we work on a full re-implementation of the library.
19+
20+
Issues targeting the `v2` branch are labelled `v2`.

0 commit comments

Comments
 (0)