Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.44 KB

Contributing to The Optimizer

Thank you for considering contributing to The Optimizer.

How to Contribute

If you want to contribute to The Optimizer, please follow these steps:

  1. Fork the repository on GitHub.

  2. Create a new branch for your feature or bug fix:

    git checkout -b your-feature-name

    Consider naming your branch feature/your-feature-name, fix/your-fix-name, or similar, to make it more descriptive.

  3. Make your changes, ensuring that your code is well-documented.

  4. Commit your changes with a clear and descriptive commit message.

    Consider following a style-guide for commit messages, such as https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53

  5. Push your changes to your forked repository.

  6. Open a pull request (PR) to the main branch of the original repository.

    When opening a PR request be explicit in it's purpose, how you approached the problem and how your solution solves it. If the PR is solving an open Issue, remember to link it by using the proper keywords.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please feel free to open an issue in the repository.

License

By contributing to The Optimizer, you agree that your contributions will be licensed under the same MPL 2.0 License as the project.