The Balean Handbook

Contributing

Public contributions

At this moment, the project that stores the handbook content is private and not open to public contributions. If you do not have access but still want to propose a contribution, then please send an email to contribute@balean.org.

You can use the following template for the email:

Dear Balean handbook maintainer,

I would like to propose a contribution to your handbook for the following page: <link to page>

Please consider the following:

* [ ] Add a child page to this page with the content below
* [ ] Change a section of this page with the content below
* [ ] Add the following content to this page

Content to be added:
<Add content here>

(optional) Content to be changed:
<Add current content here, if applicable>

With kind regards,
<your name>

Team member contributions

Anyone with access to https://gitlab.com/balean-org is able to view the handbook repository via https://gitlab.com/balean-org/about/ and can create a merge request to propose adjustment to the handbook. Only maintainers in the handbook project can merge the merge request.

If you feel insecure about creating a merge request, then please create an issue in the handbook project instead. You can use the same email template as above for the issue description to propose the change. Issue descriptions allow for markdown, making it easier to copy/paste the content to the handbook.

Licenses

The Balean handbook is developed under the MIT license. See the repository for details. All content within the handbook is created under the Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 International License. A link to that license is added to the footer of every page.

Contributions are created by and on behalf of Balean. Any copyright will be owned by Balean after a contribution is accepted. Contribution history will be available via Git repository history. It is the responsibility of the contributor to provide the relevant details via the Git commits (name and email address) to claim a contribution.