Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

62 lines (39 loc) · 2.32 KB
Raw

Contributing to Sasori

Welcome to Sasori! We're excited that you're interested in contributing to our project. By contributing, you can help make Sasori even better for everyone.

How to Contribute

If you'd like to contribute to Sasori, here are some steps to get you started:

  1. Fork the Repository: Start by forking the Sasori repository to your own GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine using Git.

    git clone https://github.com/your-username/sasori.git

  3. Create a Branch: Create a new branch for your work to keep your changes isolated from the main codebase.

    git checkout -b feature-name

  4. Make Changes: Make your desired changes to the codebase.

  5. Test Your Changes: Ensure that your changes work as expected and do not introduce any regressions.

  6. Commit Your Changes: Commit your changes with descriptive commit messages.

    git commit -m "Add feature XYZ"

  7. Push Your Changes: Push your changes to your forked repository.

    git push origin feature-name

  8. Open a Pull Request: Once you've pushed your changes to your fork, you can open a pull request against the main Sasori repository. Provide a clear description of your changes and why they are necessary.

  9. Review Process: Your pull request will be reviewed by the maintainers. You may need to address feedback or make additional changes before your changes are merged.

Code Style and Guidelines

  • Follow the coding style and guidelines established in the project.
  • Run eslint to see if all checks are passing:
npx eslint ./ --fix
  • Write clear and concise commit messages.
  • Keep your pull requests focused on a single issue or feature.
  • Ensure your changes pass any existing tests and add new tests if necessary.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. Provide detailed information about the problem you encountered and steps to reproduce it.

License

By contributing to Sasori, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to Sasori! We appreciate your support and contributions.