Skip to content

Commit 5e279d6

Browse files
authored
docs: create CONTRIBUTING.md
1 parent 11eff6e commit 5e279d6

File tree

1 file changed

+88
-0
lines changed

1 file changed

+88
-0
lines changed

CONTRIBUTING.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
4+
5+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
6+
7+
## How to Contribute
8+
9+
### 1. Fork the Repository
10+
11+
[fork](https://help.github.com/articles/fork-a-repo/) the repository on GitHub and clone it to your local machine.
12+
13+
```bash
14+
git clone https://github.com/infraspecdev/terraform-module-template
15+
```
16+
17+
### 2. Create a Branch
18+
19+
Create a new branch for your feature or bug fix. Use a descriptive name for your branch.
20+
21+
```bash
22+
git checkout -b feature/your-feature-name
23+
```
24+
25+
### 3. Make Your Changes
26+
27+
Make the necessary changes to the codebase. Ensure your changes adhere to the project's coding standards.
28+
29+
### 4. Test Your Changes
30+
31+
Test your changes thoroughly to ensure they work as expected. If possible, add tests to verify the functionality. <p>
32+
#### Checklists for contributions
33+
- [ ] `pre-commit run --all-files`
34+
- [ ] `terraform test` (If there are resources created in commits)
35+
36+
### 5. Commit Your Changes
37+
38+
Commit your changes with a descriptive commit message.
39+
40+
```bash
41+
git add .
42+
git commit -m "Add feature: Description of your feature"
43+
```
44+
45+
### 6. Push Your Changes
46+
47+
Push your changes to your forked repository.
48+
49+
```bash
50+
git push origin feature/your-feature-name
51+
```
52+
53+
### 7. Create a Pull Request
54+
55+
Github has documentation on [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
56+
57+
To generate changelog, Pull Requests or Commits must have semantic and must follow conventional specs below:
58+
59+
- `feat:` for new features
60+
- `fix:` for bug fixes
61+
- `improvement:` for enhancements
62+
- `docs:` for documentation and examples
63+
- `refactor:` for code refactoring
64+
- `test:` for tests
65+
- `ci:` for CI purpose
66+
- `chore:` for chores stuff
67+
68+
The `chore` prefix skipped during changelog generation. It can be used for `chore: update changelog` commit message by example.
69+
70+
## Code Style
71+
72+
Please ensure your code follows the existing coding style and conventions.
73+
74+
## Reporting Issues
75+
76+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
77+
78+
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
79+
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
80+
81+
* A reproducible test case or series of steps
82+
* The version of our code being used
83+
* Any modifications you've made relevant to the bug
84+
* Anything unusual about your environment or deployment
85+
86+
## Thank You!
87+
88+
Thank you for contributing to `terrafomr-module-template` ! Your support is greatly appreciated.

0 commit comments

Comments
 (0)