diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 0000000..af5f442 --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,77 @@ +# Contributing to Password-Management-Tool + +Thank you for considering contributing to Password-Management-Tool! We appreciate your interest and are excited to collaborate with you. + +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. + +## Code of Conduct + +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. + +## How to Report Issues + +If you encounter a bug, issue, or have a feature request, please follow these steps: + +1. **Check the issues**: Make sure the issue hasn't already been reported. +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. + - Provide a clear description of the issue. + - Include steps to reproduce the issue if applicable. + - Add any relevant information such as environment details or logs. + +## How to Contribute + +We welcome contributions from everyone! Here’s how you can help: + +### 1. Fork the Repository + +First, fork the repository to your GitHub account by clicking the "Fork" button at the top-right of the page. + +### 2. Clone Your Fork + +Clone your forked version to your local machine: + +```bash +git clone https://github.com//Mmabiaa/Password-Management-Tool.git +``` +3. Create a New Branch +Before you make any changes, create a new branch to work on: +``` +bash +Copy code +git checkout -b [branch-name] +``` +4. Make Your Changes +Make the necessary changes in your branch. Be sure to write clear, concise commit messages that explain the changes you made. + +5. Test Your Changes +If applicable, make sure to test your changes before submitting. Run any relevant tests, or ensure that new features work as expected. + +6. Commit Your Changes +Once you’re happy with your changes, commit them to your branch: + +```bash +git add . +git commit -m "Description of your changes" +``` +7. Push Your Changes +Push your changes to your forked repository: +``` + +bash +Copy code +git push origin [branch-name] +``` +8. Submit a Pull Request +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. + +Pull Request Guidelines +Describe your changes clearly: Explain the problem you’re solving or the feature you’re adding. +Follow the code style: Try to match the existing code style and formatting conventions. +Ensure your code works: Make sure that any code you contribute is working as expected, and tests are passing (if applicable). +Link issues: If your pull request resolves an issue, reference it with a Fixes #[issue number] in your PR description. +Licensing +By contributing to this project, you agree that your contributions will be licensed under the same license as the project. + +Thank You! +We really appreciate your help in improving Password-Management-Tool. If you have any questions or need assistance, feel free to reach out! +