Add contributing & issue template files

This commit is contained in:
Rob Garrison 2017-07-12 15:59:36 -05:00
parent 0037c699d9
commit c97151edf3
3 changed files with 66 additions and 3 deletions

33
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,33 @@
# Contributing to Stylus
1. [Getting Involved](#getting-involved)
2. [How to Report Issues](#how-to-report-issues)
3. [Adding Tranlations](#adding-translations)
4. [Core Style Guide](#core-style-guide)
5. [Getting Started](#getting-started)
## Getting Involved
There are a number of ways to get involved with the development of Stylus. Even if you've never contributed to an Open Source project before, we're always looking for help by identifying issues and suggesting improvements.
## How to Report issues
When an issue is opened, a template is provided. Please answer these questions as thoroughly as possible. If we were psychic, we'd be hanging out in casinos playing poker until they kicked us out. We can't read your mind! Please provide step-by-step direction on how to reproduce the issue as well as the browser, operating system and versions of each.
When adding a feature request, please include
## Adding Translations
You can help us translate the extension on [Transifex](https://www.transifex.com/github-7/Stylus). When `messages.json` file is ready to be merged, please open a new bug report in [stylus/issues](https://github.com/openstyles/stylus/issues).
## Core Style Guide
* Use the provided `.editorconfig` file with your code editor. Don't know what that is? Then check out http://editorconfig.org/.
## Getting Started
* First open an issue to discuss your changes.
* Then download, fork or clone this repository.
<!-- * Use [node.js](http://nodejs.org/) to run `npm install`. -->
* Make any changes within a branch of this repository (not the `master` branch).
* Submit a pull request and include a reference to the initial issue with the discussion.

28
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,28 @@
<!--
Thank you for reporting an issue. Please make sure that your style is up to
date and you checked the recent commits that your issue wasn't recently
addressed. To update:
Make sure to first update DIRECTLY from https://userstyles.org/styles/37035/
(see https://github.com/JasonBarnabe/stylish-chrome/issues/179 to know why) or,
if using the GitHub-Dark script, use the "Force Update Style" button, then
force refresh the web page (Windows: Ctrl+F5; Mac/Apple: Apple+R or Command+R;
Linux: F5).
If the issue persists, please help us identifying the cause by providing these
details:
-->
* **Browser**:
* **Operating System**:
* **Screenshot**:
* **HTML of the section where the issue occurs**:
<!-- You can get the HTML by right click on the element, look for the
highlighted node in the DevTools, right click it and select
Copy -> Outer HTML -->
````html
````

View File

@ -16,13 +16,15 @@ See the [help docs](http://userstyles.org/help/stylish_chrome) or [ask in userst
## Contributing
The source is hosted on [GitHub](https://github.com/schomery/stylus) and pull requests are welcome.
The source is hosted on [GitHub](https://github.com/openstyles/stylus) and pull requests are welcome.
You can help us translate the extension on [Transifex](https://www.transifex.com/github-7/Stylus). When `messages.json` file is ready to be merged, please open a new bug report in [stylus/issues](https://github.com/schomery/stylus/issues).
You can help us translate the extension on [Transifex](https://www.transifex.com/github-7/Stylus). When `messages.json` file is ready to be merged, please open a new bug report in [stylus/issues](https://github.com/openstyles/stylus/issues).
See our [contributing](./.github/CONTRIBUTING.md) page for more details.
## License
For copyright status of the "codemirror" directory, see codemirror/LICENSE. Everything else is:
For copyright status of the "codemirror" directory, see [codemirror/LICENSE](https://github.com/openstyles/stylus/blob/master/src/vendor/codemirror/LICENSE). Everything else is:
Copyright (C) 2005-2014 Jason Barnabe <jason.barnabe@gmail.com>