Skip to content

Commit b02fe04

Browse files
authored
chore: add contribution guidelines
1 parent ebad89b commit b02fe04

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## How to contribute to git-analytics
2+
3+
#### **Did you find a bug?**
4+
5+
- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/n0rfas/git-analytics/issues).
6+
7+
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/n0rfas/git-analytics/issues/new?template=bug_report.md). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
8+
9+
#### **Did you write a patch that fixes a bug?**
10+
11+
- Open a new GitHub pull request with the patch.
12+
13+
- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
14+
15+
#### **Do you intend to add a new feature or change an existing one?**
16+
17+
- Suggest your change in the [Github Discussions](https://github.com/n0rfas/git-analytics/discussions) and start writing code.
18+
19+
- Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
20+
21+
Thanks!

0 commit comments

Comments
 (0)