Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

57 lines (35 loc) · 2.46 KB

How to contribute

We are really glad you're reading this, because we need volunteer developers to help this project come to fruition.

We want you working on things you're excited about.

You can contact us by mail [email protected].

Or you can join Agorakube's community for discussion and ask questions : Agorakube's Slack

Channels :

  • #general - For general purpose (news, events...)
  • #developpers - For people who contribute to Agorakube by developing features
  • #end-users - For end users who want to give us feedbacks
  • #random - As its name suggests, for random discussions :)

Set up a local test lab

You can, for exemple, set a local test lab for Agorakube-docs using Git and Docker.

  1. SetUp the dev environment:
git clone https://github.com/ilkilab/agorakube-docs.git
docker run -d -p 80:80 --mount type=bind,source="$(pwd)"/agorakube-docs/www/,target=/var/site agorakube/test-agorakube-docs:v1

  1. Open your Browser and go to http://[IP_DOCKER_NODE]

  2. Edit files under ./agorakube-docs/www/. Website will be automatically updated.

Sample needs

All contributions are welcome :)

Submitting changes

Please send a https://www.mkdocs.org/(https://github.com/ilkilab/agorakube-docs) with a clear list of what you've done (read more about pull requests). When you send a pull request, we will love you forever if your code stay idempotent. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."

Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability:

  • We indent using two spaces (soft tabs)
  • You can find all the MkDocs documentation at : MkDocs Website
  • This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
  • You can use common tools like "VisualStudioCode", or "Atom" to make your Ansible code !

Thanks,

Ilki team