Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 2.16 KB

Contributing to turtile

Thank you for considering contributing to turtile We welcome contributions from anyone who is interested in helping to improve the project.

Getting Started

To get started with contributing to turtile, follow these steps:

  • Familiarize yourself with the project by reading the README and exploring the codebase.
  • Check out the wiki for more detailed information on building, configuring, and using turtile.

Submitting Changes

To submit changes to turtile, follow these guidelines:

  • Use Conventional Commits: We use Conventional Commits as our standard for commit messages. This means that your commit messages should follow the format type: subject, where type is one of feat, fix, docs, etc., and subject is a brief description of the changes.
  • Keep it Small: Try to keep your changes small and focused on a single issue or feature. This makes it easier for us to review and merge your changes.
  • Test Your Changes: Before submitting your changes, make sure to test them thoroughly to ensure that they work as expected. We recomend the use of Act for running the GitHub Actions locally.
  • Open a Pull Request: Once you've made your changes, open a pull request against the master branch. We'll review your changes and provide feedback as needed.

Before you begin working on a feature or bug fix, please take a moment to contact us to discuss your plans. This will help ensure that your contribution aligns with our project goals and avoids duplicating effort.

Types of Contributions

We welcome all types of contributions, including:

  • Bug Fixes: Help us squash bugs and improve the stability of turtile.
  • New Features: Add new features to turtile to make it more useful and customizable.
  • Documentation: Help us improve our documentation to make it easier for others to use and contribute to turtile.
  • Code Refactoring: Help us improve the codebase by refactoring existing code to make it more maintainable and efficient.