Consolidate contribution documentation

hse-project / hse

HSE: Heterogeneous-memory storage engine

https://hse-project.github.io

670 stars 65 forks source link

Consolidate contribution documentation #615

Closed tristan957 closed 1 year ago

alexttx commented 1 year ago

Remove this line about the PR template:

Use the predefined PR template and specify which issue the commit addresses, what the commit does, and provide a concise description of the change.

alexttx commented 1 year ago

Seems like we can remove the section on how to clone. Anybody that's gonna want source should know how to clone the repo.

alexttx commented 1 year ago

Other suggestions:

Consolidate Coding Style and Code Formatting sections.
Split Testing into two sections: Running Tests, and Developing Tests. Put the latter at the end of the document to hide the noise of that section. Move the Coverage section into the new Developing Tests.
The info for distribution maintainers is spread among three sections (Building For Dist Maintainers, Distributing the Source, and Distributing Binaries). Move all that into one section name "Distribution Maintainers" or something similar.

tristan957 commented 1 year ago

Perhaps the section for distribution maintainers should go elsewhere. It isn't like they are going to be reading the CONTRIBUTING.md document anyways. README.md seems like the next logical place, but I don't know.

I don't think Distributing either the source or the binaries does much good for distribution maintainers. I've done packaging for distros before, and that section isn't valuable to me. I am not sure who that section would apply to other than us. Maybe a MAINTAINERS.md? Not sure.

alexttx commented 1 year ago

You know more about dist packaging that anybody else our our team, so I'll let you make the call. If it has not value, then lose the text.

beckerg commented 1 year ago

You're not alone Steve!