We'd love to accept your contributions to this project! There are just a few guidelines you need to follow.
Bug reports should be opened up as issues on the go-vela/community repository!
Feature Requests should be opened up as issues on the go-vela/community repository!
NOTE: We recommend you start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on.
We are always open to new PRs! You can follow the below guide for learning how you can contribute to the project!
- Review the commit guide we follow - ensure your commits follow our standards
- Hugo - building block for local development
-
Fork this repository
-
Clone this repository to your workstation:
# Clone the project
git clone [email protected]:go-vela/docs.git $HOME/go-vela/docs- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/docs- Point the original code at your fork:
# Add a remote branch pointing to your fork
git remote add fork https://github.com/your_fork/docsWe use Hugo to build our site.
You will need to install:
Docsy has some of it's own requirements, listed in their getting started docs.
- PostCSS
git submodule update --init --recursiveto update the submodule
Once you've got that taken care of, from the repo root folder, run:
hugo server -w