Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 983 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 983 Bytes
Raw

Contributing Guidelines

  1. Fork the Repository: Start by forking the project repository.

  2. Clone Locally: Clone the forked repository to your local machine using a git client.

    git clone git@github.com:<your-user>/md-translator-reviewer.git

  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

    git checkout -b feature/new-feature-x

  4. Make Your Changes: Develop and test your changes locally.

  5. Commit Your Changes: Commit with a clear message describing your updates.

    npm run cz

  6. Push: Push the changes to your forked repository.

    git push origin feature/new-feature-x

  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

  8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!