How to contribute

This training manual is built using Markdown syntax, and the Documentation Theme for Jekyll, for rendering the HTML pages. All the Markdown files and Jekyll configuration files are maintained in the chaoss/grimoirelab-tutorial GitHub repository.

Pull requests to that repository are welcome. If you prefer, you can also open some issue on it, to report some bug, to propose some enhancement, to ask for some new content, or just to comment or suggest something. Any feedback is appreciated!

If you want to produce your own version of the HTML pages from the sources, ensure you have Ruby installed, and:

% git clone https://github.com/chaoss/grimoirelab-tutorial
% cd grimoirelab-tutorial
% bundle exec jekyll serve

This will produce the HTML files, and run an HTTP server that will serve them in http://localhost:4000

DCO and Sign-Off for contributions

The CHAOSS Charter requires that contributions are accompanied by a Developer Certificate of Origin sign-off. For ensuring it, a bot checks all incoming commits.

For users of the git command line interface, a sign-off is accomplished with the -s as part of the commit command:

git commit -s -m 'This is a commit message'

For users of the GitHub interface (using the “edit” button on any file, and producing a commit from it), a sign-off is accomplished by writing

Signed-off-by: Your Name <YourName@example.org>

in a single line, into the commit comment field. This can be automated by using a browser plugin like DCO GitHub UI.

Contributors