| 1 | # Contributing to laabr
|
| 2 |
|
| 3 | First and foremost, thank you! I appreciate that you want to contribute to laabr, your time is valuable, and your contributions mean a lot to me.
|
| 4 |
|
| 5 | ## Important!
|
| 6 |
|
| 7 | By contributing to this project, you:
|
| 8 |
|
| 9 | * Agree that you have authored 100% of the content
|
| 10 | * Agree that you have the necessary rights to the content
|
| 11 | * Agree that you have received the necessary permissions from your employer to make the contributions (if applicable)
|
| 12 | * Agree that the content you contribute may be provided under the Project license
|
| 13 |
|
| 14 | ## Getting started
|
| 15 |
|
| 16 | **What does "contributing" mean?**
|
| 17 |
|
| 18 | Creating an issue is the simplest form of contributing to a project. But there are many ways to contribute, including the following:
|
| 19 |
|
| 20 | - Updating or correcting documentation
|
| 21 | - Feature requests
|
| 22 | - Bug reports
|
| 23 |
|
| 24 | **Showing support for laabr**
|
| 25 |
|
| 26 | Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use.
|
| 27 |
|
| 28 | Don't have time to contribute? No worries, here are some other ways to show your support for laabr:
|
| 29 |
|
| 30 | - star the [project](https://github.com/felixheck/laabr)
|
| 31 | - tweet your support for laabr
|
| 32 |
|
| 33 | ## Issues
|
| 34 |
|
| 35 | ### Before creating an issue
|
| 36 |
|
| 37 | Please try to determine if the issue is caused by an underlying library, and if so, create the issue there. Sometimes this is difficult to know. I only ask that you attempt to give a reasonable attempt to find out. Oftentimes the readme will have advice about where to go to create issues.
|
| 38 |
|
| 39 | Try to follow these guidelines
|
| 40 |
|
| 41 | - **Avoid creating issues for implementation help**. It's much better for discoverability, SEO, and semantics - to keep the issue tracker focused on bugs and feature requests - to ask implementation-related questions on [stackoverflow.com][so] or send a mail/tweet.
|
| 42 | - **Investigate the issue**
|
| 43 | - **Check the readme** - oftentimes you will find notes about creating issues, and where to go depending on the type of issue.
|
| 44 | - Create the issue in the appropriate repository.
|
| 45 |
|
| 46 | ### Creating an issue
|
| 47 |
|
| 48 | Please be as descriptive as possible when creating an issue. Give me the information I need to successfully answer your question or address your issue by answering the following in your issue:
|
| 49 |
|
| 50 | - **version**: please note the version of laabr are you using
|
| 51 | - **extensions, plugins, helpers, etc** : please list any extensions you're using
|
| 52 | - **error messages**: please paste any error messages into the issue, or a [gist](https://gist.github.com/)
|
| 53 |
|
| 54 | ### Closing issues
|
| 55 |
|
| 56 | The original poster or the maintainer's of laabr may close an issue at any time. Typically, but not exclusively, issues are closed when:
|
| 57 |
|
| 58 | - The issue is resolved
|
| 59 | - The project's maintainers have determined the issue is out of scope
|
| 60 | - An issue is clearly a duplicate of another issue, in which case the duplicate issue will be linked.
|
| 61 | - A discussion has clearly run its course
|
| 62 |
|
| 63 | [so]: http://stackoverflow.com/questions/tagged/laabr
|