We welcome contributions to the wTools project! By contributing, you help improve this repository for everyone.
- Fork the Repository: Start by forking the
wToolsrepository on GitHub. - Clone Your Fork: Clone your forked repository to your local machine.
git clone https://github.com/your-username/wTools.git
- Create a New Branch: Create a new branch for your feature or bug fix.
or
git checkout -b feature/your-feature-name
git checkout -b bugfix/your-bug-fix
- Make Your Changes: Implement your changes, ensuring they adhere to the project's code style guidelines and design principles.
- Run Tests: Before submitting, ensure all existing tests pass and add new tests for your changes if applicable.
cargo test --workspace - Run Clippy: Check for linter warnings.
cargo clippy --workspace -- -D warnings
- Commit Your Changes: Write clear and concise commit messages.
or
git commit -m "feat(crate_name): Add your feature description" # Replace `crate_name` with the actual crate name
git commit -m "fix(crate_name): Fix your bug description" # Replace `crate_name` with the actual crate name
- Push to Your Fork:
git push origin feature/your-feature-name
- Open a Pull Request: Go to the original
wToolsrepository on GitHub and open a pull request from your branch. Provide a clear description of your changes and reference any related issues.
If you find a bug or have a feature request, please open an issue on our GitHub Issues page.
If you have any questions or need further assistance, feel free to ask on our Discord server.