Skip to content

Latest commit

 

History

History
76 lines (43 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

76 lines (43 loc) · 2.65 KB
Raw

Contributing to Chat Buddy

ChatBuddy is a Flutter application designed to facilitate real-time communication and interaction among users.

How to Contribute

0. Assigning issues from issues section

Try to get assigned in issues from issues section and solve the problem by raising the PR.

Note: Don't forget to mention the issue when raising the PR.

1. Fork the Repository

To contribute to the project, start by forking the repository to your GitHub account. This will create a copy of the project in your account where you can make changes without affecting the original repository.

2. Clone the Repository

After forking, clone the repository to your local machine using the following command:

git clone https://github.com/your-username/translate_app.git

Replace your-username with your GitHub username and translate_app with the name of the repository.

3. Create a New Branch

Before making any changes, create a new branch where you'll work on your contribution. Use a descriptive branch name that reflects the nature of your changes.

git checkout -b branch-name

4. Make Changes

Now you can make changes to the project code or documentation. Feel free to explore the open issues for ideas on what to work on. Make sure to follow the coding style and conventions used in the project.

5. Test Your Changes

Before submitting your contribution, test your changes to ensure they work as expected. Run any relevant tests and verify that the project builds without errors.

6. Commit Your Changes

Once you're satisfied with your changes, commit them to your branch with a clear and descriptive commit message.

git add .
git commit -m "Add your commit message here"

7. Push Changes

Push your changes to your forked repository on GitHub.

git push origin branch-name

8. Create a Pull Request

After pushing your changes, you can create a Pull Request (PR) to merge your changes into the main repository. Provide a descriptive title and include details about your contribution in the PR description.

9. Review and Collaborate

Your PR will be reviewed by project maintainers, who may provide feedback or request modifications. Be open to collaboration and willing to make changes based on feedback to improve your contribution.

NOTE: Mention the issue number whenever you raise the PR.

Get Help

If you have any questions or need assistance, feel free to reach out to project maintainers or the community for help. We're here to support you throughout your contribution journey!

Thank you for your interest in contributing to Translate App. Together, we can make this project even better!