diff --git a/CONTRIBUTING.textile b/CONTRIBUTING.textile new file mode 100644 index 0000000..ae05d8a --- /dev/null +++ b/CONTRIBUTING.textile @@ -0,0 +1,22 @@ +h1. Contributing + +There are several ways to participate in this project. This guide covers only the contribution of code (i. e. any change to any file in the repository). + +There are basically two ways to contribute code to this project: Either via GitLab or via e‑mail. The first one is probably easier for most people. However +it requires a account at GitLab.com. For people who don’t want to create an account—or have any other reason to not use GitLab—e‑mail is an alternative option. + +h2. Contributing via GitLab + +Create an account on GitLab.com or use your already existing account. Fork this repository inside GitLab, add changes to your fork and finally create a Merge Request to contribute your changes back to this repository. + +h2. Contributing via E‑mail + +To contribute via e‑mail, first clone this repository to your local harddrive. After adding changes to your local copy you have to options to send them back to this repository: as patch or as Pull Request + +h3.E‑mail Patch + +To send a patch with your changes, use git’s `send-email` option as explained in section "Public Project over Email":https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_project_over_email of the "Git Pro Book":https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project. You will find the e‑mail address at "suruatoel.xyz":https://www.suruatoel.xyz. + +h3. E‑mail Pull Request + +Sending a Pull Request via e‑mail requires to publish your copy of the repository that includes your changes at a publicly available URL (it is your responsibility to choose a trusted host). The e‑mail with your Pull Request will contain a link to the public repository which can be used to pull your changes from. For more details, please take a look at section "Forked Public Project":https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_public_project of the "Git Pro Book":https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project. \ No newline at end of file