Contributing

May 14, 2025 ยท View on GitHub

Contributions are welcome! If you find a bug or have a suggestion, please open an issue or a pull request. I especially appreciate any help keeping up with endpoint and data model changes.

Pull Requests

Fork the project

  1. Fork the project to your own GitHub profile.
  2. Clone the forked repository onto your local machine.
  3. git remote add upstream https://github.com/JoshGuarino/PokeGo to create a remote handle to the upstream repo.
  4. git pull upstream main to ensure you have the latest main code.
  5. git checkout -b branch-name (replacing branch-name with a suitable name) to create a branch for your changes.

Push it

  1. git add . to stage your changed files.
  2. git commit -m 'commit message' (replacing commit message with a description of the work done) to commit your changes.
  3. git push my-fork-name branch-name to push your changes to your own GitHub repository.
  4. Go to the PokeGo GitHub repo and you should see your recently pushed branches.
  5. Follow GitHub's instructions to submit a pull request.

Issues

If you find a bug or have a suggestion, please open an issue.
Please include as much information as possible, such as steps to reproduce the issue and any error messages.
It would also be helpful if you could provide a code snippet or example that demonstrates the issue. Also let me know if you have any problems with creating a pull request.