Skip to content

Latest commit

 

History

History
50 lines (42 loc) · 2.06 KB

File metadata and controls

50 lines (42 loc) · 2.06 KB

Contributing to wTools

We welcome contributions to the wTools project! By contributing, you help improve this repository for everyone.

How to Contribute

  1. Fork the Repository: Start by forking the wTools repository on GitHub.
  2. Clone Your Fork: Clone your forked repository to your local machine.
    git clone https://github.com/your-username/wTools.git
    
  3. Create a New Branch: Create a new branch for your feature or bug fix.
    git checkout -b feature/your-feature-name
    or
    git checkout -b bugfix/your-bug-fix
  4. Make Your Changes: Implement your changes, ensuring they adhere to the project's code style guidelines and design principles.
  5. Run Tests: Before submitting, ensure all existing tests pass and add new tests for your changes if applicable.
    cargo test --workspace
  6. Run Clippy: Check for linter warnings.
    cargo clippy --workspace -- -D warnings
  7. Commit Your Changes: Write clear and concise commit messages.
    git commit -m "feat(crate_name): Add your feature description" # Replace `crate_name` with the actual crate name
    or
    git commit -m "fix(crate_name): Fix your bug description" # Replace `crate_name` with the actual crate name
  8. Push to Your Fork:
    git push origin feature/your-feature-name
  9. Open a Pull Request: Go to the original wTools repository on GitHub and open a pull request from your branch. Provide a clear description of your changes and reference any related issues.

Reporting Issues

If you find a bug or have a feature request, please open an issue on our GitHub Issues page.

Questions?

If you have any questions or need further assistance, feel free to ask on our Discord server.