Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.81 KB

Contributing to TouchFish Client

We welcome contributions from the community to help improve TouchFish Client! Whether you're reporting bugs, suggesting new features, or submitting code changes, your input is valuable to us.

How to Contribute

  1. Fork the Repository: Start by forking the TouchFish Client repository on GitHub to your own account.

  2. Clone Your Fork: Clone your forked repository to your local machine using the following command:

    git clone https://github.com/YourUsername/TouchFish-Client.git

  3. Create a Branch: Create a new branch for your changes. Use a descriptive name for the branch that reflects the purpose of your changes.

    git checkout -b your-branch-name

  4. Make Changes: Make your changes to the codebase. Ensure that your code follows the existing coding style and conventions.

  5. Test Your Changes: Before submitting your changes, make sure to test them thoroughly to ensure they work as expected and do not introduce new issues.

  6. Commit Your Changes: Commit your changes with a clear and concise commit message that describes what you have done.

    git add .
git commit -m "Your commit message"

  7. Push to Your Fork: Push your changes to your forked repository on GitHub.

     git push origin your-branch-name

  8. Create a Pull Request: Go to the original TouchFish Client repository on GitHub and create a pull request from your forked repository. Provide a detailed description of your changes and why they should be merged.

Requirements

  • Ensure that your code is well-documented and follows best practices.
  • Use descriptive names for branches and commit messages.
  • Test your changes thoroughly before submitting a pull request.
  • Be respectful and considerate in all communications.