Before contributing to this project, you must join the community, by following a few simple steps.
- You need to join the Mailing List
- You should join the Public Slack
- All members are expected to adhere to our Code of Conduct
Org membership processes and tiers will be discussed in Q1 of 2021
Please refer to the list of existing issues and the existing documentation, to familiarize yourself with the current state of the project and what is already being accomplished.
- DO use Github issues to discuss features and design.
- DON'T use Github issues to ask usage questions, and instead post questions to our public [Slack] (https://stormforge.slack.com) in the #vhs-to-be-renamed channel or the [mailing list] (https://groups.google.com/g/vhs-pre-rename-launch).
Getting Started
Begin by forking this repo and submitting PRs from your local fork.
Security Issues
- TBD
Features
Issues should be opened for any significant feature work. Please open an issue prior to working on any feature to make sure someone else isn’t already working on it, and to coordinate with others on design decisions and feature progress.
New Plugins
- TBD
Tests and Testing
- TBD
Reporting Bugs
Please be thorough in bug reporting. Bug reports should be specific, including as much relevant detail as possible, and reproducible, including the steps taken to reproduce the bug. Also, please keep to a single bug per report.
If you know which area of the code is causing the bug, even better.
Commits should be made to solve either specific problems or to open future growth. Features and feature requests should be made with growth in mind.
We use the Developer Certificate of Origin (or DCO), for developers to individually certify they have the right to contribute the code, documentation, or other works they are submitting. Your signature on any submission certifies that you are authorized to submit your patch as outlined by the below certificate.
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Sign your work in Commit Messages on every commit (or squash your commits and sign the squashed result)
Example of Signoff:
Signed-off-by: Boaty McBoatface <boaty@example.org>
Use your real name, no pseudonyms or anonymous contributions.
The git -s option will append the Signed-off-by line automatically to your commit messages, if you have set user.name and user.email in your git configs.
git config --global user.name "Boaty McBoatface"
git config --global user.email "boaty@example.org"
git commit -s -m "Adding Boating Support"
Format
- TBD
Requirements
At a bare minimum, please describe what changed and why. Remember, other people will be reading this, and you need to tell them what you've done.
All merges will/can be performed by any Org members, until additional maintainer tiers are deemed necessary.
Approvers must verify commits are signed (There is no bot checking DCO signatures, yet)
All changes must be approved by a number of Org members, not including the submitter.
- Documentation PRs require only a single approver
- New code or code changes require two approvers
- TBD
- TBD