Contributing to 'xord/all'

March 10, 2025 · View on GitHub

Thank you for your interest in contributing to this project! Please follow the guidelines below to ensure a smooth contribution process.

How to Contribute

  1. Fork the repository: Create a fork of the repository on GitHub.
  2. Clone the repository: Clone your fork locally on your machine.
  3. Create a branch: Create a new branch for your feature or bug fix.
  4. Make your changes: Make your changes and commit them with clear messages.
  5. Run tests: Ensure all tests pass before submitting your changes.
  6. Submit a pull request: Push your branch to your fork and submit a pull request to the main repository.

Code Style Guidelines

  • Please follow the code style used in the existing codebase. Refer to the existing code for examples of formatting, naming conventions, and general style.
  • If you're unsure about a particular style or convention, look at similar code in the repository to maintain consistency.
  • Write tests whenever possible.

Running Tests

Before submitting your PR, make sure to run the tests:

$ bundle install
$ bundle exec rake test

Pull Request Guidelines

  • Provide a clear description of your changes.
  • Reference any relevant issue numbers (e.g., "Fixes #123").
  • Ensure your code passes all checks and tests.
  • Keep your PR as small and focused as possible.

Reporting Issues

If you find a bug or have a feature request, please open an issue. When reporting a bug, include:

  • Steps to reproduce the bug.
  • Expected vs. actual behavior.
  • Any relevant logs or error messages.

Thank You!

We really appreciate your contribution! 🙌

License Agreement

By contributing to this project, you agree that your contributions will be licensed under the MIT license. You also agree that, should the project's license change in the future, you will not assert any rights to the code you have contributed, and you will not object to any new licensing terms.

If you have any concerns regarding licensing, please feel free to reach out to us before making your contributions.

We value your contributions and appreciate your understanding! 🙏