Skip to content

Commit b31e312

Browse files
authored
chore: add CONTRIBUTING.md (#198)
1 parent 47fd607 commit b31e312

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to `commit-and-tag-version`
2+
3+
Thank you for considering contributing to `commit-and-tag-version`! Your help is greatly appreciated.
4+
5+
## How to Get Started
6+
7+
1. **Fork** this repository to your GitHub account.
8+
2. **Clone** the forked repository to your local machine.
9+
3. **Create** a new branch for your contributions.
10+
4. **Make** your changes or additions.
11+
5. **Push** the branch to your forked repository.
12+
6. **Submit** a pull request and describe the changes made.
13+
14+
## Bug Reports
15+
16+
If you encounter any bugs, please open an [issue](https://github.com/absolute-version/commit-and-tag-version/issues) and include:
17+
18+
- A detailed description of the bug.
19+
- Steps to reproduce the bug.
20+
- Expected and actual behavior.
21+
- Your environment (OS, browser, etc.).
22+
23+
## Feature Requests
24+
25+
To suggest new features or enhancements, please open an [issue](https://github.com/absolute-version/commit-and-tag-version/issues) with:
26+
27+
- A clear and detailed description of the feature.
28+
- The problem it would solve or the use case it would address.
29+
- Any implementation suggestions.
30+
31+
## Pull Request Guidelines
32+
33+
- Ensure your code adheres to the project’s coding standards.
34+
- Write tests for new features or bug fixes.
35+
- Update documentation as necessary. If there are user facing changes / new features, please ensure the `Readme.md` is updated
36+
- Provide a comprehensive description of your changes in the pull request.
37+
- Do not include `package.lock.json` modifications; only include `package.json`. Maintainers will be responsible to generate it.
38+
- Do not include multiple features in a single commit/PR
39+
- Please title the PR with [conventional commits](https://www.conventionalcommits.org/), as PRs are squash merged
40+
41+
We look forward to your contributions and value your time and effort!

0 commit comments

Comments
 (0)