Skip to content

Contributing

Thank you for your interest in contributing to Solnix!

How to Contribute

We welcome contributions to Solnix! Whether you're fixing bugs, improving documentation, or adding new features, your help is greatly appreciated.

Reporting Bugs

If you find a bug, please report it on our GitHub Issues page. When reporting, please include:

  • A clear and concise description of the bug.
  • Steps to reproduce the behavior.
  • Expected behavior.
  • Screenshots or error messages if applicable.
  • Your environment details (OS, Solnix version).

Suggesting Enhancements

For new features or improvements, please open an issue on our GitHub Issues page with the label enhancement.

Code Contributions

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

  2. Clone Your Fork: Clone your forked repository to your local machine:

    bash git clone https://github.com/your-username/solnix-compiler.git cd solnix-compiler

  3. Create a New Branch: Create a new branch for your feature or bug fix:

    bash git checkout -b feature/your-feature-name

    or for bug fixes:

    bash git checkout -b fix/bug-description

  4. Make Your Changes: Implement your changes, ensuring that your code adheres to the existing coding style.

  5. Test Your Changes: If you are adding new features or fixing bugs, please write appropriate tests.

  6. Commit Your Changes: Commit your changes with a clear and descriptive commit message:

    bash git commit -m "feat: Add new feature" or for bug fixes: bash git commit -m "fix: Resolve bug in X"

  7. Push to Your Fork: Push your branch to your forked repository:

    bash git push origin feature/your-feature-name

  8. Open a Pull Request: Go to the original Solnix repository on GitHub and open a pull request from your forked branch to the main branch. Provide a detailed description of your changes.

Documentation Contributions

Improvements to the documentation are always welcome! You can contribute by:

  • Correcting typos or grammatical errors.
  • Clarifying existing explanations.
  • Adding new sections or examples.

Documentation changes follow the same Pull Request process as code contributions. The documentation source is located in the docs directory.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please ensure you read and understand it.

Thank you for making Solnix better!