search

TheMinusWorld / Mayhem-Whereabouts

Master repository for the Mayhem Whereabouts software
GNU Affero General Public License v3.0
0 stars 1 forks source link

Define style guides / rules for contributing #3

Open wtl420 opened 4 years ago

wtl420 commented 4 years ago

Having a consistent style to adhere to is important for any project and makes things easier to maintain in the long run.

Additionally, having definite rules for contributing helps that process as well.

wtl420 commented 4 years ago

One proposal I'd like to make is that code can't be accepted into the official codebase (master, development, or whatever branches we decide are the Real ones) without code reviews. Preferably at least 2 other people can look over each pull request, but if we don't have the manpower we can do just one at a time.

wtl420 commented 4 years ago

I'd also like to use this to establish how we're planning on meeting up to discuss different aspects of this. I proposed before doing some kind of weekly standup to make sure we're all on track and some kind of public meeting each month in addition to that to let the people watching know what's happening behind the scenes and give them some room to contribute to areas that are relevant to what we're working on.

wtl420 commented 4 years ago

https://www.contributor-covenant.org/version/1/4/code-of-conduct I think is worth integrating.

Need to see what is in other projects CONTRIBUTING.md file to see what makes sense to include as far as that goes.

wtl420 commented 4 years ago

This is partially blocked by #2 due to issues with the PHP tooling for enforcing style guides. I should draft up the documentation for what rules regardless and prepare that for review.