This document will briefly describe basic guidelines for contributors. All project communication shall be done at issues or FlutterBuddies Discord server. Everything in this text that you find confusing or have any objections, can and should be discussed at issues or Discord.
The upcoming titles sort of describe the order of things you want to explore before contributing.
If you'd like to talk about the project in general, please do at project's Discord channel. We can go on from there.
Issues at this repository are a main place to look at when planning to contribute. Two situations can occur:
Your idea is already present in an issue
In this case, after reading all the comments at this issue to assess the situation and how it aligns with your ideas, you can
- add your comment with some further insight or a question
- contact issue's assignee (either by leaving a comment with assignee tagged or contacting assignee directly) for details on how can you contribute code
You have an idea not present in issues
In this case, you can create a new issue with detailed explanation of your idea, question or bug report with minimal code example if applicable. Then the other contributors will comment further at your issue and you can plan how this will be developed. By default, you can then become the assignee at this issue, the one who will be responsible for it's development. Of course, this is not forced upon anyone so you can let us know in the comments that you prefer not to be the assignee. Then others can apply to be the assignee.
If an issue doesn't have an assignee, the position is open for anyone who wants it. In this assigneeless situation, the "acting assignee" is the project creator (Zambrella).
To contribute, you will eventually be doing a Pull Request for your fork. First, you need to fork the repository and set the upstream via git remote add upstream https://github.com/Flutter-Buddies/sudoku-solver.git.
When you fork the project, you will be at main branch by default. To switch branches (if necessary) , use git checkout <branch-name>. It will be clearly discussed on which branch should each issue be worked on.
If you are contributing at some branch for a while, to have the latest changes if something has been pushed in the meantime, do git fetch upstream. This will create branches upstream/<branch-name> that you then need to merge into your branch you're working on. To do that, git checkout <branch-name> (if you're not already on it) and git merge upstream/<branch-name>.
- Git Handbook
- GitHub Hello World
- git branches - official GitHub docs
- Fork - official GitHub docs
- Syncing a fork - official GitHub docs
- Syncing a fork - StackOverflow
- Creating a pull request from a fork - official GitHub docs
It is sufficient that you format your code. See here how this can be accomplished and automated.