Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.72 KB

contributing.md

File metadata and controls

45 lines (34 loc) · 1.72 KB

Contributing to Supertitle

Whether you're looking to raise an issue, fix a bug, or add a feature, This document helps you contribute to this project.

Code of Conduct

We expect all contributors to act professionally and respectfully, and we expect our social channels to be a safe and enjoyable environment for all.

How to Contribute

  1. Fork this repo: Before you make any commit, make sure your fork is up to date with the main branch.

    git pull origin main
  2. Create a new branch: Create a new branch where you'll commit to this code base.

    git checkout -b my-new-feature
  3. Make your changes: Make the necessary changes to the code or documentation.

  4. Commit your changes: Once you've made your changes, commit them.

    git add .
    git commit -m "Add some feature"

Note: If errors occur, run yarn format to fix and remove lint errors prior to pushing changes.

  1. Push your changes: Push the changes to your new branch on your fork.
    git push origin my-new-feature
  2. Create a pull request: Go to your fork on GitHub and click the 'Compare & pull request' button next to your new branch to create a new pull request.

Pull Requests

  • The pull request should have a descriptive title and any necessary explanations in the comments.
  • Make sure your pull request is based on the latest commits to avoid conflicts.

Style Guidelines

  • Adhere to the existing coding style.
  • Write your code in TypeScript, ensuring it follows best practices.

Review Process

  • The repo owner will review the pull request and provide feedback or merge it.
  • If changes are required, make them and push them to the same branch.