Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.22 KB

Contributing to Merlin

First of all, thank you for considering contributing to this project! 🎉

Code of Conduct

Please review and adhere to our Code of Conduct before contributing.

How to Contribute

  1. Fork the repository.
  2. Create a new branch with a descriptive name: git checkout -b feature/your-feature or git checkout -b bugfix/your-bugfix.
  3. Make your changes and commit them: git commit -m 'Description of your changes'. (Would be better if you use Conventional Commits for commit messages)
  4. Push your changes to your fork: git push origin feature/your-feature.
  5. Open a pull request against the main branch of the original repository.

Pull Request Guidelines

  • Clearly describe the problem or feature.

  • Ensure your code is well-documented.

  • Ensure your code follows the project's coding standards. To make sure the project is using the correct formatting you and use these commands:

    make fmt lint
  • Include any necessary tests for your changes.

Feature Requests and Bug Reports

  • For feature requests or bug reports, open an issue and use the appropriate template.

Thank you for contributing! 🚀