Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 2.43 KB
Raw

Contributing to TODO to Issue

Thank you for considering contributing to TODO to Issue! We welcome contributions from everyone and appreciate your efforts to help improve this project.

How to Contribute

  1. Fork the Repository: Click the "Fork" button at the top right of this page to create your own copy of the repository.

  2. Clone Your Fork: Clone your fork to your local machine:

    git clone https://github.com/alstr/todo-to-issue-action.git

  3. Create a Branch: Create a new branch for your feature or fix:

    git checkout -b my-feature-branch

  4. Make Your Changes: Make your changes and ensure they align with the project's code style.

  5. Add Tests: If you are adding new language definitions or making any significant changes, please include tests to ensure the stability of the project. PRs without tests cannot be considered.

  6. Run Existing Tests: Before submitting your changes, run the existing tests to verify that everything is still working correctly.

  7. Commit Your Changes: Commit your changes with a descriptive message:

    git commit -m "Add a new feature or fix a bug"

  8. Push Your Changes: Push your changes to your fork:

    git push origin my-feature-branch

  9. Create a Pull Request: Go to the original repository and create a new pull request. Be sure to provide a clear description of your changes and reference any relevant issues.

New Language Support

If you are interested in adding support for a new language, we encourage you to submit your contribution as a pull request if you are able. This approach is more likely to result in your changes being integrated into the codebase. Issues requesting new language support are welcome, but PRs are preferred.

Writing Tests

When adding new language definitions, please refer to the current tests for the style to use. Your tests should be clear and concise, ensuring that they effectively validate your changes. For reference, check the existing tests in the tests directory.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please treat everyone with respect and kindness.

Questions?

If you have any questions or need help, feel free to open an issue or reach out to us. We are here to help!

Thank you for contributing to TODO to Issue! 🎉