Contributing to Pyramid Lint

Thank you for using Pyramid Lint and taking the time to contribute!

This document outlines the process for contributing to Pyramid Lint. Please take a moment to review this document to ensure an easy and effective contribution process for everyone involved.

Table of Contents

• How to Contribute
  • Bug Reports
  • Feature Requests
  • Documentation
  • Pull Requests

How to Contribute

Bug Reports

If you encounter a bug, please report it here and provide steps or sample code to reproduce the bug. Remember to search for existing issues before submitting a new issue.

Feature Requests

I would love to hear your ideas for new features! If you have an idea for a new lint, quick fix, assist or any other feature, please create a new issue to describe your idea.

Documentation

Suggestions and requests for improving the documentation are welcome! If you have any ideas to enhance the clarity, completeness, or organization of the documentation, please share your ideas by creating a new issue.

Pull Requests

1. Before submitting a pull request, it is recommended to create an issue to discuss the changes you would like to make. This allows for better collaboration and ensures that your contributions align with project goals.
2. Fork the repository and create a new branch from main.
3. Make your changes and commit them to your branch.
4. Format your code with dart format . in both packages/pyramid_lint/ and packages/pyramid_lint_test/.
5. Analyze your code with dart analyze . in both packages/pyramid_lint/ and packages/pyramid_lint_test/.
6. Analyze your code with dart run custom_lint . or custom_lint .(if you have custom_lint installed globally) in packages/pyramid_lint_test/.
7. Test your code with dart test in packages/pyramid_lint_test/.
8. Commit and push your changes to your fork.
9. Create a pull request to the main branch of the repository.

Thank you for contributing to Pyramid Lint! I am glad to have you here, and I hope you enjoy using Pyramid Lint. ❤️