Skip to content

Latest commit

 

History

History
49 lines (27 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

49 lines (27 loc) · 2.04 KB
Raw

Contributing Guidelines

We welcome contributions from everyone, whether you're a seasoned developer or a first-time contributor.

How to Contribute

  1. Fork the repository and clone it locally.

  2. Create a new branch for your changes.

  3. Make your changes and commit them to your branch. Use meaningful commit messages that clearly describe the changes you've made.

  4. Push your branch to your forked repository and open a pull request.

  5. The project maintainers will review your pull request and provide feedback. If any changes are required, please make them in your branch and push them to your forked repository.

  6. Once your changes have been reviewed and approved, they will be merged into the main repository.

Code Quality

  • Make sure your code compiles without warnings and new features should be covered by tests.
  • Make sure all tests pass before submitting your pull request.
  • Code lines should be wrapped after 100 characters.
  • Function and class/structure names need to be written in camel case. Names must be concise, but should express the general intent.

Code of Conduct

Please be sure to review and follow our Code of Conduct.

Communication

  • For general questions or discussion, please use the project's issue tracker.
  • For sensitive or confidential issues, please contact the project maintainers directly.

Attribution

  • Please provide attribution for any code or documentation that you use or modify, by linking to the original source.

License

By contributing to "BEAST - Binary Evolution And Sentience Toolkit", you agree that your contributions will be licensed under the project's license.

Code Style

We use the Google C++ style guide for this project. Please make sure your contributions adhere to this style.

Documentation

All relevant changes need to be documented using Doxygen. You can refer to the existing codebase for examples on how to properly format your documentation.