Welcome to wpm! We're thrilled that you're interested in contributing. Before you get started, please take a moment to read this document to understand how you can contribute to our project.
-
Fork the Repository: Click the "Fork" button at the top right of the repository's page on GitHub. This will create a copy of the repository in your GitHub account.
-
Clone Your Fork: Clone your forked repository to your local machine using
git clone.git clone https://github.com/your-username/your-project.git
-
Create a Branch: Create a new branch for your work. Use a descriptive name that summarizes your feature or bug fix.
git checkout -b feature/my-new-feature
-
Make Changes: Make your changes, following the coding conventions and guidelines described in the project.
-
Test Your Changes: Ensure that your changes work as expected.
-
Commit Your Changes: Commit your changes with a clear and concise commit message following the conventional commits guidelines.
git commit -m "feat: added feature that xyz" -
Push to Your Fork: Push your changes to your fork on GitHub.
-
Create a Pull Request: Go to the GitHub page of your forked repository, switch to the branch with your changes, and click the "New Pull Request" button. Provide a clear title and description for your pull request.
If you encounter a bug, have a feature request, or have questions about the project, please open an issue on our GitHub repository. When reporting an issue, be sure to:
- Provide a descriptive title and clear description of the issue.
- Specify the steps to reproduce the problem, if applicable.
- Include any relevant error messages or screenshots.
If you find a bug or have a feature request, please open an issue to report it.
By contributing to this project, you agree that your contributions will be licensed under the project's license.
Thank you for your contributions!