Some-Apps / ShelterPartner

Helping animal shelters with a volunteer facing app
https://shelterpartner.org
MIT License
4 stars 3 forks source link
github open-source opensource

Welcome To ShelterPartner!

The plan is to switch everything to Flutter by the end of the year and scrap the swift and kotlin versions as soon as that's done.

How To Contribute On GitHub

  1. Create an issue in the Some-Apps/ShelterPartner repository or select an existing issue. Issues that I've labeled as "up next" are higher priority but you're welcome to work on anything even if it isn't marked as "up next".
  2. Comment on the issue that you would like to work on it
  3. Once you have been assigned the issue, fork to the repository into a branch containing the issue number
  4. When you are ready, submit a pull request from this branch
  5. Your code will be reviewed and then either be approved or have changes requested
  6. Once the pull request has been approved, you can safely delete your branch and start on a new issue.

Feel free to use your issue thread to communicate. Contributors will only be assigned one issue at a time.

File Organization

Follow MVVM repository architecture. For example:

lib/
  models/
    animal.dart
  views/
    pages/
      animals_page.dart
    components/
      animal_card_view.dart
  view_models/
    animals_view_model.dart
  repositories/
    animal_repository.dart

Contributor Incentives

Gather Account (1 contribution per month)

Contributors who make 1 approved pull request or more per month will be given a desk in a virtual office building. This will allow you to interact with other contributors while you work or just talk and play online mini games.

Github Copilot (5 contributions per month)

Contributors who make 5 approved pull requests or more per month will be given access to Github Copilot.

ChatGPT (60 contributions per year)

Contributors who make 60 approved pull requests or more per year will be given an annual ChatGPT subscription.

Contributors

Photo User Contributions Perks
JaredDanielJones's avatar JaredDanielJones NA NA
rhjones777's avatar rhjones777 11 contributions None
jacobthejones's avatar jacobthejones 6 contributions Gather Account
kateoconn1's avatar kateoconn1 2 contributions None