Add CONTRIBUTING.md

[batpad]

Breaking out of conversation here: https://github.com/IFRCGo/go-api/pull/806#issuecomment-655900648

We should add more comprehensive developer documentation to the backend repository, as we have more people working on the code. This should cover code-style guidelines, setting up linters, writing tests.

There's a bit of clean-up that would ideally be done before this makes sense, to ensure the current code follows the guidelines.

@thenav56 @gulfaraz

[nanometrenat]

@batpad is this ticket still relevant?

[thenav56]

Hey @nanometrenat Thanks for the reminder :D. Yes, it is still relevant. We were thinking of implementing checks using CI using tools like black. We will need to document those using CONTRIBUTING.md

Sample configs for future reference.

• https://github.com/IFRCGo/alert-hub-backend/blob/2ff1195eacef96c2361a909c69a81b6c84630e93/.github/workflows/ci.yaml#L15-L23
• https://github.com/IFRCGo/alert-hub-backend/blob/develop/.pre-commit-config.yaml

The changes will change most of the codebase, so we will need to make these changes after all PRs have been merged to avoid change conflicts. cc: @udaynwa @szabozoltan69

[nanometrenat]

Hi peeps! Is this still a thing? Not sure if some of the older PRs in this repo will ever be merged at this stage.

[thenav56]

Hey @nanometrenat, Thanks for checking in

We've made some updates in PR #2128, which this depends on. We will start working on this soon.

• https://github.com/IFRCGo/go-api/pull/2128

Furthermore, we can close this one https://github.com/IFRCGo/go-api/issues/811 now

• https://github.com/IFRCGo/go-api/issues/811

cc: @samshara @udaynwa