Skip to content

Commit e1adaf8

Browse files
committed
document contribution
1 parent ab31ecc commit e1adaf8

3 files changed

Lines changed: 48 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing
2+
3+
Please refer to the [documentation](https://pycalendar.github.io/ical2jcal/contributing/).

docs/contributing.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contribution Guide
2+
3+
To get started with development,
4+
[read the documentation](development.md).
5+
6+
## Maintainers
7+
8+
Maintainers are:
9+
10+
- [Nicco Kunzmann](https://github.com/niccokunzmann)
11+
- [Steve Piercy](https://github.com/stevepiercy)
12+
- [Sashank Bhamidi](github.com/SashankBhamidi)
13+
14+
They can:
15+
16+
- merge pull requests
17+
- push changes to `main`
18+
- release new versions
19+
20+
Maintainers need access to:
21+
22+
- pypi (invite maintainer)
23+
- github (invite admin)
24+
25+
## Contributions
26+
27+
Contributors
28+
29+
- can submit pull requests
30+
- can work on branches inside the repository
31+
32+
## Merge requirements
33+
34+
- Passing tests
35+
- Documentation builds successfully and passes checks. Any changes to documentation should render correctly in the pull request preview on Read the Docs.
36+
- A change log entry is included, except for trivial matters, such as typographical errors and updating links. Preferably, this would be enforced through CI.
37+
- All conversations should be addressed and resolved.
38+
- At least one approval from a maintainer or code owner.
39+
- Maintainers may override any or all of the requirements, but should add a comment explaining their reason for doing so.
40+
- If pull requests do not receive a review from another maintainer, after 7 days, the maintainer can merge it.
41+
42+
## Stale pull requests
43+
44+
If an open pull request has had no activity for at least seven days, either through a comment or commit by the contributor, then a maintainer or code owner should ask the contributor whether they need help to complete the work. After another seven days, the maintainer or code owner may resolve the open pull request using their best judgment.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ nav:
9999
- compatibility.md
100100
- Contributing:
101101
- development.md
102+
- contributing.md
102103
- Licensing:
103104
- licenses/license.md
104105
- licenses/license_report.md

0 commit comments

Comments
 (0)