Further Open source contributor onboarding improvements - Githubissues

BMMRO-tech / BMMRO

MIT License

3 stars 5 forks source link

Further Open source contributor onboarding improvements #144

Open aiwatko opened 3 years ago

aiwatko commented 3 years ago

Main readme

[ ] Create a more extensive overview of what the project is trying to achieve
[ ] Perhaps include the link to the operating manual

Contributing file

[ ] Explain how the contributor is expected to contribute to architectural decision records
[ ] Explain what happens after the contributor submits the PR - do they need to notify someone? how many approvals are needed?
[ ] Explain what convention to use to name pull requests and commits

Export script readme

[ ] The script does not work if there is no database, perhaps it should be included in the readme

App readme

[ ] NB: You can’t run the export scripts test and the FE tests at the same time (both use port 8080)
[ ] Testing issue: firebase: command not found. Add to README steps to install the firebase cli tool - npm install -g firebase-tools separately

josh-simpson-TW commented 2 years ago

Split off one of the App readme tasks, as this is already in progress: https://github.com/BMMRO-tech/BMMRO/issues/220