Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

56 lines (40 loc) · 2.13 KB

Contributing to vpaw

There are many ways to contribute to vpaw.

The PR Process, and Related Gotchas

How to submit a PR ?

If you are new to vpaw development and you don't have push access to the vpaw repository, here are the steps:

  1. Fork and clone the repository.
  2. Create a branch.
  3. Push the branch to your GitHub fork.
  4. Create a Pull Request.

This corresponds to the Fork & Pull Model described in the GitHub documentation guides.

If you have push access to this repository, you could simply push your branch and create a Pull Request. This corresponds to the Shared Repository Model and will facilitate other developers to checkout your topic without having to configure a remote. It will also simplify the workflow when you are co-developing a branch.

When submitting a PR, make sure to add a Cc: @vpaw/developers comment to notify vpaw developers of your awesome contributions. Based on the comments posted by the reviewers, you may have to revisit your patches.

How to integrate a PR ?

Getting your contributions integrated is relatively straightforward, here is the checklist:

  • All tests pass
  • Consensus is reached. This usually means that at least one reviewer added a LGTM comment and a reasonable amount of time passed without anyone objecting. LGTM is an acronym for Looks Good to Me.

Next, there are two scenarios:

  • You do NOT have push access: A vpaw core developer will integrate your PR.
  • You have push access: Simply click on the "Merge pull request" button.

Then, click on the "Delete branch" button that appears afterward.