Contributing to Reactix

Thank you for your interest in contributing! Reactix welcomes contributions from users and developers of all experience levels.

Get help or ask questions

If you have a question about usage or want to discuss an idea, please use GitHub Discussions or send an email to a.storiko@tudelft.nl.

Report issues

If you find a bug, encounter unexpected behavior, or want to propose a feature, please open an issue on GitHub.

Share examples

If you are using Reactix, we are curious to hear about it! You are welcome to share examples in the GitHub Discussions under the Show and tell category.

Community guidelines

Please note that all contributions to this project are expected to adhere to the Code of Conduct. We will enforce this code throughout all interactions, including comments, commits, code, edits, issues, and other contributions. We will communicate reasons for moderation decisions when appropriate.

Contribute code

If you would like to contribute code or documentation, this is best done via a pull request. Please follow these steps:

  1. Fork the repository.
  2. Clone your fork of the repository.
  3. Create a feature branch to hold your development changes.
  4. Make your improvements, tests, and documentation updates.
  5. Open a pull request against develop.

If you are planning major changes please consider opening an issue first to discuss.

If you are not familiar with GitHub workflows but still want to contribute, feel free to reach out by email and we can find a way to collaborate.

In the next section, you can find more detailed guidelines for contributing code.

Back to top