Skip to content
This repository was archived by the owner on Apr 8, 2023. It is now read-only.

Commit a84a747

Browse files
committed
docs: Add Contributing guides
1 parent 989291c commit a84a747

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing to my package
2+
3+
Welcome, and thank you for your interest in contributing to **vscode-csscomb**!
4+
5+
Please note that this project is released with a [Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.
6+
7+
## Contribution Guidelines
8+
9+
There are a couple of ways you can contribute to this repo:
10+
11+
* **Ideas, feature requests and bugs**: We are open to all ideas and we want to get rid of bugs! Use the [Issues section](https://github.com/mrmlnc/vscode-csscomb/issues) to either report a new issue, provide your ideas or contribute to existing threads.
12+
* **Documentation**: Found a typo or strangely worded sentences? Submit a PR!
13+
* **Code**: Contribute bug fixes, features or design changes.
14+
15+
### Creating an Issue
16+
17+
Before you create a new Issue:
18+
19+
* Check the [Issues](https://github.com/mrmlnc/vscode-csscomb/issues) on Github to ensure one doesn't already exist.
20+
* Clearly describe the issue, including the steps to reproduce the issue.
21+
22+
### Making Changes
23+
24+
#### Getting Started
25+
26+
* Install [Node.js](https://nodejs.org/en/).
27+
* Fork the project and clone the fork repo. ([how to create fork?](https://help.github.com/articles/fork-a-repo/#fork-an-example-repository)).
28+
* Create a topic branch from the master branch.
29+
* Run `yarn` or `npm install` to install the application dependencies.
30+
31+
#### Setup
32+
33+
1. Start watching:
34+
35+
```
36+
$ npm run watch
37+
```
38+
39+
2. Make changes:
40+
41+
```
42+
$ code .
43+
```
44+
45+
3. Run tests:
46+
47+
```
48+
$ npm t
49+
```
50+
51+
4. Test your version of the extension:
52+
53+
Press <kbd>F5</kbd> in the editor and then test extension commands and functions.
54+
55+
#### Commit
56+
57+
Keep git commit messages clear and appropriate. You can use [Angular guide](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).

0 commit comments

Comments
 (0)