Skip to content

Latest commit

 

History

History
70 lines (52 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

70 lines (52 loc) · 2.59 KB
Raw

Contributor Instructions

Before building the site, ensure that you have the following dependencies installed on your system.

Building the site

Run the following:

  1. cd TemplateRun.io
  2. make setup
  3. make site

Please contribute! The TemplateRun site uses Gatsby. The process of contributing to documentation follows this flow:

  1. Fork a copy of this repo.
  2. Get a local clone of your fork of the site. git clone https://github.com/TemplateRun/TemplateRun.io
  3. Switch to the main branch. git checkout main
  4. Create and checkout a new branch to make changes within git checkout -b <my-username>/<my-changes>
  5. Edit site/add content. vi <specific page>.md # or use your favorite IDE
  6. Run site locally to preview changes. make site # this will run a local web server with "live reload" conveniently enabled.
  7. Commit your changes to your remote branch. git commit --signoff -m"<commit subject>
  8. Push your changes git push origin <my-username>/<my-changes>
  9. Open a pull request (in your web browser) against the master branch on https://github.com/TemplateRun/TemplateRun.io.

Signing-off on Commits (Developer Certificate of Origin)

To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution.

See the DCO file for the full text of what you must agree to and how it works here. To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages:

Signed-off-by: Taylor Swift <[email protected]>

In most cases, you can add this signoff to your commit automatically with the -s or --signoff flag to git commit. You must use your real name and a reachable email address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit:

$ commit -s -m “my commit message”

To ensure all your commits are signed, you may choose to add this alias to your global .gitconfig:

~/.gitconfig

[alias]
  amend = commit -s --amend
  cm = commit -s -m
  commit = commit -s

Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you: