Create Brevitas Contributor Doc v1 - Githubissues

Xilinx / brevitas

Brevitas: neural network quantization in PyTorch

https://xilinx.github.io/brevitas/

Other

1.2k stars 197 forks source link

Create Brevitas Contributor Doc v1 #857

Open capnramses opened 8 months ago

capnramses commented 8 months ago

Why

Help new developers joining team, and external contributors understand expectations of development flow.

What

I think it's fine to start with a simple .md that can be linked from the main Readme.md.
Make it extremely clear at the top that it's for people developing for Brevitas, and not with Brevitas, as a user.
Guidelines for accepting PRs from external contributors.
Guideline for 1 Issue -> 1 Branch -> 1 PR.
How the Release cycle works - version numbers and timeline and branches.

Practical Steps e.g.

This is too much for a starter, but some thoughts:

Make a fork of Brevitas - from which branch.
Make a feature branch - named appropriately.
Link to branch from an Issue, where possible, or indicate in Issue comments if being worked on.
Testing and branch refresh expectations prior to PR.
Make a PR. Description template.
CI/CD and testing expectations.
Expectations around review process and merge. e.g. timelines and order of PR merging.

capnramses commented 8 months ago

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

capnramses commented 8 months ago

related https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

capnramses commented 8 months ago

Note the steps to double-check are currently pinned in internal slack channel.