open.source/stylus
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update on CONTRIBUTING.md (#430)

Browse Source 
Update contribution guidelines
This commit is contained in:
stonecrusher 2018-07-14 18:56:26 +02:00 committed by tophf
parent 513e4337eb
commit e60628b51a
1 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
.github/CONTRIBUTING.md vendored
View File

@ -1,33 +1,37 @@
# Contributing to Stylus # Contributing to Stylus
1. [Getting Involved](#getting-involved) 1. [Getting involved](#getting-involved)
2. [How to Report Issues](#how-to-report-issues) 2. [How to report issues](#how-to-report-issues)
3. [Adding Tranlations](#adding-translations) 3. [Adding translations](#adding-translations)
4. [Core Style Guide](#core-style-guide) 4. [Pull requests](#pull-requests)
5. [Getting Started](#getting-started) 5. [Contact us](#contact-us)
## Getting Involved ## 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. 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 ## 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 an [**issue**](https://github.com/openstyles/stylus/issues) 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 directions on how to reproduce the issue as well as the versions of your operating system, browser and Stylus.
When adding a feature request, please include When adding a **feature request**, please search through the existing issues to see if it the feature has already been requested, added or rejected.
## Adding Translations If not, then provide details describing which page the feature will effect, e.g. popup, manager or editor. Then describe the request and explain how you think it would benefit the user experience.
## 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). 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 ## Pull requests
* 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. * First open an issue to discuss your changes.
* Then download, fork or clone this repository. * Then download, fork or clone this repository.
<!-- * Use [node.js](http://nodejs.org/) to run `npm install`. --> <!-- * Use [node.js](https://nodejs.org/) to run `npm install`. -->
* Use the provided `.editorconfig` file with your code editor. Don't know what that is? Then check out https://editorconfig.org/.
* Make any changes within a branch of this repository (not the `master` branch). * 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. * Submit a pull request and include a reference to the initial issue with the discussion.
## Contact us
If you prefer a more informal method of getting in touch or starting a conversation, please [join us on Discord](https://discordapp.com/widget?id=379521691774353408) or leave a comment in the [discussion section](https://add0n.com/stylus.html#reviews). We will monitor any discussions there and join in, and it may be a more appropriate venue for opinions and less urgent suggestions.