Skip to content

Latest commit

 

History

History
49 lines (26 loc) · 3.49 KB

contributing.md

File metadata and controls

49 lines (26 loc) · 3.49 KB
Raw

Contributing to Sedenion Engine

Thank you for considering contributing to Sedenion Engine! We welcome contributions from the community to help improve and grow the project. By contributing, you can help make Sedenion Engine a more powerful and reliable scientific calculator and CAS solver for everyone to use.

Ways to Contribute

There are several ways you can contribute to the Sedenion Engine project:

  1. Code Contributions: If you have experience with Rust programming, you can contribute by writing code to add new features, fix bugs, optimize performance, or improve existing functionalities.

  2. Documentation: Clear and well-structured documentation is crucial for the project's success. If you are skilled in technical writing, you can help improve the project's documentation, including code comments, README files, and user guides.

  3. Testing: Comprehensive testing is essential to ensure the reliability and correctness of the Sedenion Engine. You can contribute by writing and running tests, and reporting any issues you encounter.

  4. Bug Reports: If you find any bugs or unexpected behavior while using Sedenion Engine, please report them on our issue tracker. Detailed bug reports with steps to reproduce the issue will help us address and resolve the problems more effectively.

  5. Feature Requests: If you have ideas for new features or improvements to the existing ones, we would love to hear from you. You can open feature requests on our issue tracker, providing a clear description of the feature and its potential benefits.

Getting Started

Before you start contributing, here are some steps to help you get started:

  1. Familiarize Yourself with the Codebase: Take some time to explore the existing codebase. Familiarize yourself with the project structure and coding conventions.

  2. Set Up Your Development Environment: Follow the instructions in the README to set up your development environment and build the project.

  3. Check for Open Issues: Check the issue tracker to see if there are any open issues that you would like to work on. If you're starting with something new, it's a good idea to discuss your plans with the community first to avoid duplication of effort.

  4. Create a Branch: For each contribution, create a new branch from the main branch with a descriptive name (e.g., feature/new-calculator-widget or bugfix/issue-123).

  5. Submit Your Changes: Once you've made your changes, submit a pull request (PR) from your branch to the main branch. Provide a clear and detailed description of your changes in the PR, along with any relevant information or context.

Code Guidelines

To maintain consistency and readability, please follow these code guidelines when contributing to Sedenion Engine:

  • Adhere to the existing code formatting and style by running cargo fmt before committing.
  • Use meaningful variable and function names to enhance code readability.
  • Write unit tests for new features or bug fixes.

We also request that your commit messages follow the angular commit message style excluding scope. More info here.

License

By contributing to Sedenion Engine, you agree that your contributions will be licensed under the same GNU GPL-v3 license as the project itself in licensed under it.

Thank you for contributing to Sedenion Engine! Your efforts are valued and appreciated by the community. Together, we can make Sedenion Engine a powerful and reliable tool for everyone to use.