poush / H2

Supporting light weight extensions for heavy task lifting
MIT License
16 stars 32 forks source link

Improvements needed in Contribute section of README #66

Open shashaBot opened 5 years ago

shashaBot commented 5 years ago

The contribute section of README is highly lacking. The steps demonstrate how to run the application with the current state of the repo but doesn't help very much with contribution part. For example, it doesn't include how to make the changes and making a pull request from the contributor's fork (I think that's the model being followed).

Opening this issue to discuss how to approach this. We can go multiple ways: improving the section under README or creating a new CONTRIBUTING doc with more extensive branch policies, pull request template.

poush commented 5 years ago

Inspiration can be taken from: https://github.com/fossasia/open-event-server#contributions-best-practices

parent issue: #36