At first I want to thank you for your interest in contributing to Ying.
You should follow these steps in order to make a successful contribution:
- Install Dart from this website. PS: You don't need flutter in order to run this project.
- Fork the repository (you can do that on the repository page in the top right corner)
- Clone the repository to your local filesystem (usually done via
git clone [email protected]:MY-USERNAME/ying.git
- make sure to replace "MY-USERNAME" with your actual username) - Make changes to the source code
- Commit the changes with the conventional commit schema (usually done via
git add .
andgit commit -m "Describe the changes here"
) - Push the changes to your fork (usually done via
git push
) - Create a pull request (after you have pushed your changes to your fork, Github should show the "Contribute" button)
- Make sure that your fork is up-to-date with the latest changes. You can do this quickly via the "Sync fork" button.
- Give your pull request a meaningful title + description so we can get the gist of your changes without looking into the changes.
- Wait for feedback
- We will comment your pull request if we found something which should be changed
- Your pull request gets accepted and will be merged into the main repository!