diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7748f3f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# Contributing to Soenneker.Utils.AsyncSingleton + +We're excited that you're interested in contributing. Before you get started, please take a moment to read through this guide to understand how you can contribute to the project. + +## How to Contribute + +1. **Create an Issue** + - If you have a new feature idea, a bug report, or any other improvement suggestion, start by creating an issue on the [Issues](https://github.com/soenneker/soenneker.utils.asyncsingleton/issues) page. + - Clearly describe the problem or enhancement you're proposing and provide as much detail as possible. + +2. **Fork the Repository** + - If you want to work on a feature or bug fix, fork the repository to your GitHub account. Click the "Fork" button at the top right corner of the repository. + +3. **Clone the Repository** + - Clone the repository to your local machine using the following command: + ``` + git clone https://github.com/soenneker/soenneker.utils.asyncsingleton.git + ``` + +4. **Create a Branch** + - Create a new branch for your contribution. Use a descriptive name that reflects the purpose of your changes. + ``` + git checkout -b your-feature-branch + ``` + +5. **Make Changes** + - Implement your changes or add new features. Be sure to follow the coding conventions and guidelines of the project. + +6. **Test Your Changes** + - Test your changes thoroughly to ensure that they work as expected. + +7. **Commit Changes** + - Commit your changes with a clear and concise commit message. + ``` + git commit -m "Brief description of your changes" + ``` + +8. **Push Changes** + - Push your changes to your forked repository on GitHub. + ``` + git push origin your-feature-branch + ``` + +9. **Create a Pull Request (PR)** + - Go to the [Pull Requests](https://github.com/soenneker/soenneker.utils.asyncsingleton/pulls) page of the original repository. + - Click on "New Pull Request." + - Select your forked repository and the branch with your changes. + - Provide a clear title and description for your pull request. + - Click "Create Pull Request." + +10. **Code Review** + - Your pull request will be reviewed by the maintainers. Be responsive to any feedback and make necessary changes. + +11. **Merge** + - Once your pull request is approved, it will be merged into the main branch. + +Thank you for contributing to Soenneker.Utils.AsyncSingleton!