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: .github/CONTRIBUTING.md
+5-6
Original file line number
Diff line number
Diff line change
@@ -24,12 +24,12 @@ Want to contribute? Great. Please review the following guidelines carefully and
24
24
## Requesting new features
25
25
26
26
1. Search for similar feature requests; someone may have already requested it.
27
-
2. Make sure your feature fits DevDocs's [vision](https://github.com/freeCodeCamp/devdocs/blob/master/README.md#vision).
27
+
2. Make sure your feature fits DevDocs's [vision](../README.md#vision).
28
28
3. Provide a clear and detailed explanation of the feature and why it's important to add it.
29
29
30
30
## Requesting new documentations
31
31
32
-
Please don't open issues to request new documentations.
32
+
Please don't open issues to request new documentations.
33
33
Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) where everyone can vote.
34
34
35
35
## Contributing code and features
@@ -44,7 +44,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher
44
44
45
45
## Contributing new documentations
46
46
47
-
See the [wiki](https://github.com/freeCodeCamp/devdocs/wiki) to learn how to add new documentations.
47
+
See the [`docs` folder](https://github.com/freeCodeCamp/devdocs/tree/master/docs) to learn how to add new documentations.
48
48
49
49
**Important:** the documentation's license must permit alteration, redistribution and commercial use, and the documented software must be released under an open source license. Feel free to get in touch if you're not sure if a documentation meets those requirements.
50
50
@@ -55,13 +55,12 @@ In addition to the [guidelines for contributing code](#contributing-code-and-fea
55
55
* Remove as much content and HTML markup as possible, particularly content not associated with any entry (e.g. introduction, changelog, etc.).
56
56
* Names must be as short as possible and unique across the documentation.
57
57
* The number of types (categories) should ideally be less than 100.
58
-
* Don't modify the icon sprite. I'll do it after your pull request is merged.
59
58
60
59
## Updating existing documentations
61
60
62
-
Please don't submit a pull request updating the version number of a documentation, unless a change is required in the scraper and you've verified that it works.
61
+
Please don't submit a pull request updating only the version number and/or the attribution of a documentation. Do submit a pull request if a bigger change is required in the scraper and you've verified that it works.
63
62
64
-
To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/c/2B0hmW7M/52-request-updates-here).
63
+
To ask that an existing documentation be updated, first check the latest [documentation versions report](https://github.com/freeCodeCamp/devdocs/issues?utf8=%E2%9C%93&q=Documentation+versions+report+is%3Aissue+author%3Adevdocs-bot+sort%3Acreated-desc). Only create an issue if the documentation has been wrongly marked as up-to-date.
0 commit comments