Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (24 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 1.14 KB

How to Contribute

This repository is a template. The contribution guide below is a generic placeholder. You should adapt it to the specific needs of your project.

Getting Started

  • Ensure you have read the project's README.md.
  • If you are proposing a new feature, open an issue first to discuss it.

Making Changes

  1. Fork the repository on GitHub.
  2. Create a new branch for your changes. 
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them with a clear and descriptive message.
  4. Push your branch to your fork on GitHub. 
    git push origin feature/your-feature-name
  5. Open a Pull Request to the main branch of the original repository.

Pull Request Checklist

  • My code follows the style guidelines of this project.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have updated the documentation accordingly.

For more ideas on what to include in a contributing guide, check out the Contributor Covenant's guide.