You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+44-44Lines changed: 44 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,22 +3,22 @@
3
3
We would love for you to contribute to Codelyzer and help make it even better than it is
4
4
today! As a contributor, here are the guidelines we would like you to follow:
5
5
6
-
*[Question or Problem?](#question)
7
-
*[Issues and Bugs](#issue)
8
-
*[Feature Requests](#feature)
9
-
*[Submission Guidelines](#submit)
10
-
*[Coding Rules](#rules)
11
-
*[Commit Message Guidelines](#commit)
6
+
-[Question or Problem?](#question)
7
+
-[Issues and Bugs](#issue)
8
+
-[Feature Requests](#feature)
9
+
-[Submission Guidelines](#submit)
10
+
-[Coding Rules](#rules)
11
+
-[Commit Message Guidelines](#commit)
12
12
13
13
## <aname="question"></a> Got a Question or Problem?
14
14
15
15
Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](stackoverflow.com/questions/tagged/codelyzer) where the questions should be tagged with tag `codelyzer`.
16
16
17
17
StackOverflow is a much better place to ask questions since:
18
18
19
-
* there are thousands of people willing to help on StackOverflow
20
-
* questions and answers stay available for public viewing so your question / answer might help someone else
21
-
* StackOverflow's voting system assures that the best answers are prominently visible.
19
+
- there are thousands of people willing to help on StackOverflow
20
+
- questions and answers stay available for public viewing so your question / answer might help someone else
21
+
- StackOverflow's voting system assures that the best answers are prominently visible.
22
22
23
23
To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.
24
24
@@ -37,10 +37,10 @@ Repository. If you would like to _implement_ a new feature, please submit an iss
37
37
a proposal for your work first, to be sure that we can use it.
38
38
Please consider what kind of change it is:
39
39
40
-
* For a **Major Feature**, first open an issue and outline your proposal so that it can be
40
+
- For a **Major Feature**, first open an issue and outline your proposal so that it can be
41
41
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
42
42
and help you to craft the change so that it is successfully accepted into the project.
43
-
***Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
43
+
-**Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
44
44
45
45
Later, your issue will be closed and tagged with `votes needed`. The [top-👍 feature](https://github.com/mgechev/codelyzer/issues?utf8=%E2%9C%93&q=label%3A%22votes+needed%22+sort%3Areactions-%2B1-desc+) requests will be implemented.
46
46
@@ -52,10 +52,10 @@ Before you submit an issue, please search the issue tracker, maybe an issue for
52
52
53
53
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario by providing a snippet which breaks any of the codelyzer rules. Also make sure that you list:
54
54
55
-
* version of Codelyzer used
56
-
* version of Angular used
57
-
* 3rd-party libraries and their versions
58
-
* and most importantly - a use-case that fails
55
+
- version of Codelyzer used
56
+
- version of Angular used
57
+
- 3rd-party libraries and their versions
58
+
- and most importantly - a use-case that fails
59
59
60
60
You can file new issues by filling out our [new issue form](https://github.com/mgechev/codelyzer/issues/new).
61
61
@@ -69,17 +69,17 @@ If the fix that you want to submit is part of the metadata associated with any o
69
69
70
70
Before you submit your Pull Request (PR) consider the following guidelines:
71
71
72
-
* Search [GitHub](https://github.com/mgechev/codelyzer/pulls) for an open or closed PR
72
+
- Search [GitHub](https://github.com/mgechev/codelyzer/pulls) for an open or closed PR
73
73
that relates to your submission. You don't want to duplicate effort.
74
-
* Make your changes in a new git branch:
74
+
- Make your changes in a new git branch:
75
75
76
76
```shell
77
77
git checkout -b my-fix-branch master
78
78
```
79
79
80
-
* Create your patch, **including appropriate test cases**.
81
-
* Follow our [Coding Rules](#rules).
82
-
* Commit your changes using a descriptive commit message that follows our
80
+
- Create your patch, **including appropriate test cases**.
81
+
- Follow our [Coding Rules](#rules).
82
+
- Commit your changes using a descriptive commit message that follows our
83
83
[commit message conventions](#commit). Adherence to these conventions
84
84
is necessary because release notes are automatically generated from these messages.
85
85
@@ -89,18 +89,18 @@ Before you submit your Pull Request (PR) consider the following guidelines:
89
89
90
90
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
91
91
92
-
* Push your branch to GitHub:
92
+
- Push your branch to GitHub:
93
93
94
94
```shell
95
95
git push origin my-fix-branch
96
96
```
97
97
98
-
* In GitHub, send a pull request to `codelyzer:master`.
99
-
* If we suggest changes then:
98
+
- In GitHub, send a pull request to `codelyzer:master`.
99
+
- If we suggest changes then:
100
100
101
-
* Make the required updates.
102
-
* Re-run the Codelyzer test and lint suites to ensure tests are still passing and you're following the coding style.
103
-
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
101
+
- Make the required updates.
102
+
- Re-run the Codelyzer test and lint suites to ensure tests are still passing and you're following the coding style.
103
+
- Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
104
104
105
105
```shell
106
106
git rebase master -i
@@ -114,25 +114,25 @@ That's it! Thank you for your contribution!
114
114
After your pull request is merged, you can safely delete your branch and pull the changes
115
115
from the main (upstream) repository:
116
116
117
-
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
117
+
- Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
118
118
119
119
```shell
120
120
git push origin --delete my-fix-branch
121
121
```
122
122
123
-
* Check out the master branch:
123
+
- Check out the master branch:
124
124
125
125
```shell
126
126
git checkout master -f
127
127
```
128
128
129
-
* Delete the local branch:
129
+
- Delete the local branch:
130
130
131
131
```shell
132
132
git branch -D my-fix-branch
133
133
```
134
134
135
-
* Update your master with the latest upstream version:
135
+
- Update your master with the latest upstream version:
136
136
137
137
```shell
138
138
git pull --ff upstream master
@@ -142,8 +142,8 @@ from the main (upstream) repository:
142
142
143
143
To ensure consistency throughout the source code, keep these rules in mind as you are working:
144
144
145
-
* All features or bug fixes **must be tested** by one or more specs (unit-tests).
146
-
* We follow [Google's JavaScript Style Guide][js-style-guide].
145
+
- All features or bug fixes **must be tested** by one or more specs (unit-tests).
146
+
- We follow [Google's JavaScript Style Guide][js-style-guide].
0 commit comments