Contributing to @tidy

We welcome contributions to @tidy!

Here's how you can contribute:

Reporting Issues

• Use the GitHub Issue Tracker: Clearly describe the issue, including steps to reproduce it.
• Provide a Minimal Reproducible Example: If possible, create a simple code snippet that demonstrates the issue.

Suggesting Features

• Create a GitHub Issue: Explain the feature you'd like to see, including any use cases or benefits.
• Discuss the Feature: Engage with the community and developers to refine the feature proposal.

Contributing Code

1. Fork the Repository: Create a fork of the @tidy repository on GitHub.
2. Create a New Branch: Create a new branch for your feature or bug fix.
3. Make Your Changes: Implement your changes, following the existing code style and conventions.
4. Test Thoroughly: Ensure your changes don't introduce new bugs or regressions.
5. Commit Your Changes: Commit your changes with clear and concise commit messages.
6. Push to Your Fork: Push your changes to your forked repository.
7. Create a Pull Request: Submit a pull request to the main repository, describing your changes and addressing any potential issues raised in the review process.

Code Style and Conventions

• Follow the existing code style and conventions.
• Write clear and concise code comments.
• Use consistent formatting and indentation.

Testing

• Write unit tests to cover your changes.
• Run existing tests to ensure no regressions.

Code Review and Feedback

• Be open to feedback and suggestions.
• Address any issues raised in the review process.

By following these guidelines, you can help make @tidy even better!