Thank you for considering contributing to eslint-plugin-ts-ignore-comments. We appreciate your time and effort in improving the project. Please follow the guidelines below to ensure a smooth and effective contribution process.
-
Fork the Repository: Create a personal fork of the repository on GitHub.
-
Clone Your Fork: Clone your fork to your local machine.
git clone https://github.com/your-username/eslint-plugin-ts-ignore-comments.git
-
Create a Branch: Create a new branch for your work. Use a descriptive branch name:
- For new features:
feat/feature-description - For bug fixes:
bugfix/bug-description - For hotfixes:
hotfix/hotfix-description
git checkout -b feat/your-feature-description
- For new features:
-
Make Changes: Make your changes to the codebase, ensuring you follow the existing coding conventions and style.
-
Write Tests: Add tests for your changes to ensure they work as expected and do not break existing functionality.
-
Commit Your Changes: Commit your changes with a clear and concise commit message following the convention:
- For features:
feat: Brief description of your feature - For bug fixes:
fix: Brief description of the bug fix - For hotfixes:
hotfix: Brief description of the hotfix
git commit -m "feat: add new rule for enforcing comment format" - For features:
-
Push to Your Fork: Push your changes to your fork on GitHub.
git push origin feat/your-feature-description -
Create a Pull Request: Open a pull request to the main repository. Provide a clear description of your changes and any related issue numbers.
Please honor the existing coding style and conventions used in the project. This helps maintain consistency and readability across the codebase.
Your pull request will be reviewed by the project maintainers. Please be responsive to any feedback and make any necessary changes.
Appreciate your contribution! Thank you for helping us improve the project!