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.
-
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 page.
- Clearly describe the problem or enhancement you're proposing and provide as much detail as possible.
-
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.
-
Clone the Repository
- Clone the repository to your local machine using the following command:
git clone https://github.com/soenneker/soenneker.utils.path.git
- Clone the repository to your local machine using the following command:
-
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
- Create a new branch for your contribution. Use a descriptive name that reflects the purpose of your changes.
-
Make Changes
- Implement your changes or add new features. Be sure to follow the coding conventions and guidelines of the project.
-
Test Your Changes
- Test your changes thoroughly to ensure that they work as expected.
-
Commit Changes
- Commit your changes with a clear and concise commit message.
git commit -m "Brief description of your changes"
- Commit your changes with a clear and concise commit message.
-
Push Changes
- Push your changes to your forked repository on GitHub.
git push origin your-feature-branch
- Push your changes to your forked repository on GitHub.
-
Create a Pull Request (PR)
- Go to the Pull Requests 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."
-
Code Review
- Your pull request will be reviewed by the maintainers. Be responsive to any feedback and make necessary changes.
- Merge
- Once your pull request is approved, it will be merged into the main branch.
Thank you for contributing to Soenneker.Utils.Path!