Skip to content

Commit 9f9cb7d

Browse files
authored
Add contributing guidelines to CONTRIBUTING.md
Added guidelines for contributing to the project, including reporting issues, submitting pull requests, coding guidelines, and community expectations.
1 parent 4a43743 commit 9f9cb7d

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing to Simple Interest Calculator
2+
3+
Thank you for your interest in contributing to the Simple Interest Calculator project! We welcome contributions from developers of all levels and backgrounds. By participating in this project, you agree to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).
4+
5+
## How to Contribute
6+
7+
### Reporting Issues
8+
9+
* Use the GitHub [Issues](https://github.com/your-username/simple-interest-calculator/issues) tab to report bugs or suggest enhancements.
10+
* Provide clear, concise, and reproducible steps.
11+
12+
### Submitting Pull Requests
13+
14+
1. Fork the repository to your account.
15+
2. Clone your fork locally:
16+
17+
```bash
18+
git clone https://github.com/your-username/simple-interest-calculator.git
19+
cd simple-interest-calculator
20+
```
21+
3. Create a new branch for your feature or bug fix:
22+
23+
```bash
24+
git checkout -b my-feature-branch
25+
```
26+
4. Make your changes and commit them with clear, descriptive messages:
27+
28+
```bash
29+
git add .
30+
git commit -m "Add new feature or fix description"
31+
```
32+
5. Push your branch to your fork:
33+
34+
```bash
35+
git push origin my-feature-branch
36+
```
37+
6. Open a pull request from your branch to the `main` branch of the original repository.
38+
39+
### Coding Guidelines
40+
41+
* Follow consistent code formatting and naming conventions.
42+
* Write clear and concise comments where necessary.
43+
* Ensure your code does not break existing functionality.
44+
45+
### Code Reviews
46+
47+
* Pull requests will be reviewed by maintainers.
48+
* Be open to feedback and make revisions as requested.
49+
50+
### Community
51+
52+
* Respect all community members.
53+
* Engage positively in discussions.
54+
* Follow the [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
55+
56+
Thank you for helping improve the Simple Interest Calculator project!

0 commit comments

Comments
 (0)