Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

66 lines (41 loc) · 2.36 KB
Raw

How to contribute

This glossary is an open-source project, and we welcome contributions of all kinds, be them new material, corrections or improvements to existing material. You are also more than welcome to participate in the reviews of pull requests.

By contributing, you are agreeing that we may redistribute your work under CC-BY-4.0.

Getting Started

  1. We use the fork and pull model to manage changes. More information about forking a repository and making a Pull Request.

  2. You should branch from and submit pull requests against the master branch.

  3. The glossary is homogeneous in its writing. Please use the following template when writing new entries:

    ## TERM: The Expanded Real Meaning {#TERM}

Text.

    There should be two ##, followed by the definition. If this expands to something, you should add that in the same line after a colon, and then put a {#hyperlink} to just the unexpanded term.

    If you link to another page, please use the format «TERM» or «Title:TERM» to make the link. This should work in both the final webpage and locally on GitHub.

  4. Please install the dependencies if you want to build the glossary locally.

Dependencies

To build the glossary locally, first follow the instructions how to install gitbook-cli:

  1. Gitbook

Afterwards, install the Gitbook plugins:

$ gitbook install

Then (from the top glossary directory) build the pages and start a web server to host them:

$ gitbook serve

You can see your local version by using a web browser to navigate to http://localhost:4000 or wherever it says it's serving the book.