Skip to content

Commit d3daa87

Browse files
authored
Merge pull request #16 from Mmabiaa/content-branch
Create CONTRIBUTION.md
2 parents 00af910 + 519e131 commit d3daa87

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

CONTRIBUTION.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributing to Password-Management-Tool
2+
3+
Thank you for considering contributing to Password-Management-Tool! We appreciate your interest and are excited to collaborate with you.
4+
5+
This guide provides you with the necessary information to get started contributing to this repository. Please follow the steps outlined below to make the process smoother for everyone involved.
6+
7+
## Code of Conduct
8+
9+
We ask that all contributors adhere to the following [Code of Conduct](CODE_OF_CONDUCT.md). It is important that we foster a welcoming, respectful, and collaborative environment for everyone involved.
10+
11+
## How to Report Issues
12+
13+
If you encounter a bug, issue, or have a feature request, please follow these steps:
14+
15+
1. **Check the issues**: Make sure the issue hasn't already been reported.
16+
2. **Create a new issue**: If it's a new issue, open a new issue in the [Issues](https://github.com/Mmabiaa/Password-Management-Tool/issues) section.
17+
- Provide a clear description of the issue.
18+
- Include steps to reproduce the issue if applicable.
19+
- Add any relevant information such as environment details or logs.
20+
21+
## How to Contribute
22+
23+
We welcome contributions from everyone! Here’s how you can help:
24+
25+
### 1. Fork the Repository
26+
27+
First, fork the repository to your GitHub account by clicking the "Fork" button at the top-right of the page.
28+
29+
### 2. Clone Your Fork
30+
31+
Clone your forked version to your local machine:
32+
33+
```bash
34+
git clone https://github.com//Mmabiaa/Password-Management-Tool.git
35+
```
36+
3. Create a New Branch
37+
Before you make any changes, create a new branch to work on:
38+
```
39+
bash
40+
Copy code
41+
git checkout -b [branch-name]
42+
```
43+
4. Make Your Changes
44+
Make the necessary changes in your branch. Be sure to write clear, concise commit messages that explain the changes you made.
45+
46+
5. Test Your Changes
47+
If applicable, make sure to test your changes before submitting. Run any relevant tests, or ensure that new features work as expected.
48+
49+
6. Commit Your Changes
50+
Once you’re happy with your changes, commit them to your branch:
51+
52+
```bash
53+
git add .
54+
git commit -m "Description of your changes"
55+
```
56+
7. Push Your Changes
57+
Push your changes to your forked repository:
58+
```
59+
60+
bash
61+
Copy code
62+
git push origin [branch-name]
63+
```
64+
8. Submit a Pull Request
65+
Finally, go to the original repository on GitHub and submit a pull request (PR) from your forked branch. Provide a detailed description of what your pull request does and why.
66+
67+
Pull Request Guidelines
68+
Describe your changes clearly: Explain the problem you’re solving or the feature you’re adding.
69+
Follow the code style: Try to match the existing code style and formatting conventions.
70+
Ensure your code works: Make sure that any code you contribute is working as expected, and tests are passing (if applicable).
71+
Link issues: If your pull request resolves an issue, reference it with a Fixes #[issue number] in your PR description.
72+
Licensing
73+
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
74+
75+
Thank You!
76+
We really appreciate your help in improving Password-Management-Tool. If you have any questions or need assistance, feel free to reach out!
77+

0 commit comments

Comments
 (0)