- Basic knowledge of programming is mandatory.
- The ability to use Git and GitHub.
- Some knowledge of Dart and how to use Flutter is preferrable for a head start.
- UI/UX Design skills are appreciable but not mandatory.
- Some idea about Firebase or willingness to learn it.
If you'd like to add a feature or fix a bug, we're more than happy to accept pull requests! We only ask a few things:
- Ensure your code contains no analyzer errors, e.g:
- Code is strong-mode compliant.
- Code is free of lint errors.
- Format your code with
Dart-Code.dart-code
. - Write helpful documentation.
- If you would like to make a bigger / fundamental change to the codebase, please file a lightweight example PR / issue.
- Take a look at the existing Issues or create a new issue!
- Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
- Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
- Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.
1. Start by making a fork the flutter_chat_application repository. Click on the symbol at the top right corner.
2. Clone your new fork of the repository:
git clone https://github.com/<your-github-username>/flutter_chat_application
3. Navigate to the new project directory:
cd flutter_chat_application
4. Set upstream command:
git remote add upstream https://github.com/edilsonmatola/flutter_chat_application.git
5. Checkout from main to develop branch.
git checkout develop
6. Create a feature branch from the develop branch!
git checkout -b YourBranchName
7. Sync your fork or your local repository with the origin repository:
- In your forked repository, click on "Fetch upstream"
- Click "Fetch and merge"
git fetch upstream
git merge upstream/develop
Github Docs for Syncing
8. Make your changes to the source code.
9. Stage your changes and commit:
git add .
or git add *
. Instead, stage your changes for each file/folder
git add <file-name>
git commit -m "<your_commit_message>"
10. Push your local commits to the remote repository:
git push origin YourBranchName
10. Create a Pull Request!
When opening an issue or pull request, please use this template in your comment:
- I have read the contribution guidelines at CONTRIBUTING.md
- I have checked other issues/PRs to make sure this is not a duplicate
- I agree that my contribution is subject to this project's MIT License
11. Congratulations! You've made your first contribution to flutter_chat_application! 🙌🏼
How you can add more value to your contribution logs:
- Use the present tense. (Example: "Add feature" instead of "Added feature")
- Use the imperative mood. (Example: "Move item to...", instead of "Moves item to...")
- Limit the first line (also called the Subject Line) to 50 characters or less.
- Capitalize the Subject Line.
- Separate subject from body with a blank line.
- Do not end the subject line with a period.
- Wrap the body at 72 characters.
- Use the body to explain the what, why, vs, and how.
- Reference Issues and Pull Requests liberally after the first line.
In order to discuss changes, you are welcome to open an issue about what you would like to contribute. Enhancements are always encouraged and appreciated.
Sit and relax, you've made your contribution!
For help getting started with Flutter, view the online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.