mirror of
https://github.com/djrobstep/migra.git
synced 2024-09-11 05:45:51 +03:00
contrib guide
This commit is contained in:
parent
6495793329
commit
f54f328da4
23
CONTRIBUTION_GUIDE.md
Normal file
23
CONTRIBUTION_GUIDE.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# Contribution guide
|
||||||
|
|
||||||
|
## Trust the process
|
||||||
|
|
||||||
|
Up until recently, `migra` had a very laissez-faire approach to contributions, but that created a few issues that made it harder for maintainers to review and left PRs languishing for too long.
|
||||||
|
|
||||||
|
This new contributions guidelines are aimed to fix that, while still making contributing easy and approachable.
|
||||||
|
|
||||||
|
Make sure your contribution follows these steps:
|
||||||
|
|
||||||
|
- Before getting into code, raise an issue - maintainers should have useful advice on how to approach the change. Build some basic consensus on the approach before coding.
|
||||||
|
|
||||||
|
- Break the fix/feature/change into several smaller changes. Most changes will also involve changing `schemainspect` at the same time, which does most of the gruntwork under the hood of migra.
|
||||||
|
|
||||||
|
- Keep the individual PRs extremely small. 100 lines or less ideally. This one is key for making them quick and easy to review.
|
||||||
|
|
||||||
|
## Meet the maintainers
|
||||||
|
|
||||||
|
Your humble team of maintainers currently consists of the following folks:
|
||||||
|
|
||||||
|
- @djrobstep (original author)
|
||||||
|
- @maximsmol, @kennyworkman, @aidanabd (new volunteers from latch.bio)
|
||||||
|
|
Loading…
Reference in New Issue
Block a user