Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

30 lines (23 loc) · 1.35 KB

Contributing to MiniTemplate

Thank you for your interest in contributing to MiniTemplate! We appreciate your help and support. Before you get started, please take a moment to review the following guidelines.

How to Contribute

1. Reporting Issues

If you encounter any bugs or have suggestions for improvements, feel free to open an issue on the issue tracker.

2. Feature Requests

If you have an idea for a new feature, we would love to hear about it! Open a new issue and describe the feature in detail. Be sure to explain the use case and benefits of the feature.

3. Submitting Pull Requests

If you’d like to contribute code to MiniTemplate, follow these steps:

  1. Fork the repository on GitHub.
  2. Create a new branch off of main for your feature or bug fix.
  3. Commit your changes with clear, concise messages.
  4. Push your branch to your forked repository.
  5. Open a pull request against the main branch of the main repository.

4. Code Style

  • Follow existing patterns and structure.
  • Write clear, concise comments where necessary.
  • Ensure that your changes do not break existing functionality.
  • Test your changes thoroughly before submitting a pull request.

5. Testing

Before submitting your pull request, make sure to run any relevant tests:

cd ./tests && ./run_tests.sh