Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create documents explaining how to contribute and what to look out for. #28

Open
Jonas-Sander opened this issue Sep 11, 2021 · 2 comments

Comments

@Jonas-Sander
Copy link
Collaborator

Some random notes:

  • Create CONTRIBUTING.md
  • Explain Pull-Request Flow (WIP/Review - first create issue if you're unsure about the change)
  • Definition of done (Testing (Unit / E2E), Analytics, ....)
  • How to do local testing (is this possible? Might we need to create another Firestore project?)
  • Where does which code go?
  • Which structure do we use for our code (BLOC, Domain logic, etc.)
  • We do not gurantee that we add your change
  • Code of Conduct?
@Jonas-Sander
Copy link
Collaborator Author

Also we should create a general overview about the structure of the code (e.g. what are the general domains and how do they relate to each other?) and the repository (what folders are there and where are things located? - e.g. translations, helper scripts, etc).

@nilsreichardt
Copy link
Member

The CONTRIBUTING.md of other open source projects:

This can help us to get inspiration for our CONTRIBUTING.md and understand what the best practice is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants