PokeDex App
Imagine the PokeDex Ash used to carry around in his pocket 🤔
We are gonna build this! Not exactly like above, but an app that Ash would have used if Pokemon started airing in 2021.
Contributing to PokeDex
We develop with Github
We use github to host code, to track issues and feature requests, as well as accept pull requests.
Contributions are done via a Pull request. They are used to propose the changes you've made in the code to the codebase. So for that , Fork the repository. Follow the instructions below to clone, build the app and make a pull request.
Ways to clone and build the app
-
Clone the repository
https://github.com/infiniteoverflow/PokeDex.git -
Get packages
flutter pub get -
Build app
flutter run -
Create a new branch from master/main branch
git checkout -b add "your branch name" -
Make the changes in the code
-
In order to commit the changes, you need to 'add' the changes.
git add <list-of-files-changed>
Important :
Make sure you add the files that have been changed only.
Avoid using git add .
Commit your changes along with a commit message
git commit -m "A relevant message"
-
Push your code to your branch
git push -u origin <your-branch-name> -
To create a pull request, click on
Compare and pull request -
Add an appropiate title and description to your pull request explaining the changes made
-
Click on
create pull request -
You have successfully raised a pull request !
We actively welcome your pull requests!
-
Make sure your code lints.
-
If you've changed APIs, update the documentation.
-
Issue the pull request made.
-
If you've added code that should be tested, add tests.