Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 1.61 KB

Contributing to QuIC.github.io

Hi there! We’re thrilled that you’d like to contribute to this project. Please read the following prior to forking or submitting code.

For local development

Install/update Jekyll (and its dependencies if necessary) prior to cloning this repository.

Then: bundle exec jekyll serve --livereload

Branching Strategy

In general, contributors should develop on branches based off of main and pull requests should be made against main.

Submitting a pull request

  1. Please read our code of conduct and license.
  2. Fork and clone the repository.
  3. Create a new branch based on main: git checkout -b <my-branch-name> main.
  4. Make your changes.
  5. Commit your changes using the DCO. You can attest to the DCO by commiting with the -s or --signoff options or manually adding the "Signed-off-by".
  6. Push to your fork and submit a pull request from your branch to main.
  7. Pat yourself on the back and wait for your pull request to be reviewed.

Here are a few things you can do that will increase the likelihood of your pull request to be accepted:

  • Follow the existing style where possible.
  • Write tests where applicable.
  • Keep your change as focused as possible. If you want to make multiple independent changes, please consider submitting them as separate pull requests.
  • Write a good commit message.