CONTRIBUTING.md

Contributing to in-toto.io

Thank you for considering contributing to in-toto.io! Here are the steps to set up the project on your local machine.

Review Contribution Guidelines

Before contributing, please review our detailed contribution guidelines to ensure that your code follows our style guidelines and is properly tested.

Sign the Developer Certificate of Origin (DCO)

All contributors must sign the Developer Certificate of Origin (DCO) by adding a "Signed-off-by" line to their commit messages. This indicates your acceptance of the DCO. You can do this by appending the following line to each commit message (see git commit --signoff)

Quick Start Guide

To get started with contributing to in-toto.io, follow these steps:

1. Clone the Repository

Clone the in-toto.io git repository to your local machine:

git clone https://github.com/in-toto/in-toto.io.git

2. Install Development Dependencies

Navigate to the project root directory and install the necessary dependencies with Yarn. If you do not have Yarn installed, please install it by following the instructions on the Yarn installation guide:

cd in-toto.io
npm install

3. Install Hugo

We use Hugo to build the site. Follow the Hugo installation guide to install Hugo on your system.

4. Serve the website

Once Hugo is installed, you can locally serve the website to see your changes in real-time:

npm run serve

This starts a local server. View the site at the URL displayed in your terminal, usually http://localhost:1313.

Need Help?

If you encounter any issues or have any questions, feel free to open an issue on the repository or reach out to the maintainers.

Happy contributing!