kikobar/fablab-docs
1
0
Fork 0
mirror of https://github.com/fablabsg/fablab-docs.git synced 2024-12-22 10:54:12 +00:00
Code Issues Actions Packages Projects Releases 2 Wiki Activity

Add contribute guidelines

Browse source
This commit is contained in:
Enrique Barcelli 2024-08-23 19:17:05 +08:00
parent ed2055e5af
commit 6086ef7fcd
Signed by: kikobar
GPG key ID: 006C13A68E25D3B7
1 changed files with 75 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,75 @@
# Contributing to FabLab Singapore
First of all, thanks a lot for taking the time to contribute!
All types of contribuions are encouraged and appreciated.
> And if you like the project, but just don't have time to contribute, that's pefectly fine. There are many other ways to support the project and show your appreciation, which we would be very happy about:
>
> * Star the project.
> * Shout out about it in social media.
> * Mention the project to your friends and colleagues.
> * Refer this project in your own projects.
## I Have a Question
Before asking a question, please search for existing [Issues](https://github.com/FabLabSG/fablab-docs/issues) that might help you. In case you found a suitable issue but still need clarification, you can write your question in this issue.
If you still need to ask a question we recommend:
* Open and [Issue](https://github.com/FabLabSG/fablab-docs/issues/new).
* Provide as much context and information as you can about the issue/question you are facing.
We will take care of the issue as soon as possible.
## Reporting Bugs
Bugs and errors are tracked as issues.
* Open an [Issue](https://github.com/FabLabSG/fablab-docs/issues/new).
* A good bug report should be able to describe the issue and allow others to reproduce it in their own systems, so please provide details about:
* The specific OS, platform and version you are using.
* The steps to reproduce the issue.
* The behavior you are expecting.
* The problematic behaviour you are observing.
* Include examples, screenshots, logs and whatever else you think it could be helpful.
We will take care of your report as soon as possible.
> Please note that you must never report security related issues, vulnerabilities or bugs including sensitive informetion through the issue tracker, or elsewhere in public. Sensitive bugs must be sent by encrypted email to <kiko@barcelli.net> using the following PGP key: [0x70c7d0901133471df2e6e9a8006c13a68e25d3b7](https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x70c7d0901133471df2e6e9a8006c13a68e25d3b7)
## Suggesting Enhancements
Suggestions and enhancements are discussed and managed as issues.
* Make sure you are using the latest version.
* Search and read carefully for existing discussions about similar suggestions in the [Issues](https://github.com/FabLabSG/fablab-docs/issues). You may consider adding your comments or suggestion to an existing issue.
* If you consider that your suggestion will be better represented as a new entry:
* Open an [Issue](https://github.com/FabLabSG/fablab-docs/issues/new).
* Use a **clear and descriptive title** for the issue to identify the suggestion.
* Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
* You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to.
* **Explain why this enhancement would be useful** to most users of the project. You may also want to point out the other projects that solved it better and which could serve as inspiration.
We will consider your suggestion as soon as possible.
## I Want To Contribute Content
> ### Legal Notice
>
> When contributing content to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
To contribute content to this project:
* Clone or fork the repo, and make your suggested contributions.
* Publish your contributions to any publicly available Git server.
* Send a git-request-pull to [fablab@smt-acc.com](mailto:fablab@smt-acc.com) for consideration.
We will consider your git-request-pull as soon as possible.
## Login Credentials
In order to contribute to this project in any of the ways described above, you will need login credentials to the server where this repository is hosted.
You may contact the administrator of this server to request for an account to be created for you.