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
+7-17Lines changed: 7 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,20 +24,18 @@ 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
-
For general feedback and ideas, please use the [mailing list](https://groups.google.com/d/forum/devdocs).
31
-
32
30
## Requesting new documentations
33
31
34
-
Please don't open issues to request new documentations.
32
+
Please don't open issues to request new documentations.
35
33
Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) where everyone can vote.
36
34
37
35
## Contributing code and features
38
36
39
37
1. Search for existing issues; someone may already be working on a similar feature.
40
-
2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something I may not want to merge. This also tells other contributors that you're working on the feature.
38
+
2. Before embarking on any significant pull request, please open an issue describing the changes you intend to make. Otherwise you risk spending a lot of time working on something we may not want to merge. This also tells other contributors that you're working on the feature.
41
39
3. Follow the [coding conventions](#coding-conventions).
42
40
4. If you're modifying the Ruby code, include tests and ensure they pass.
43
41
5. Try to keep your pull request small and simple.
@@ -46,7 +44,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher
46
44
47
45
## Contributing new documentations
48
46
49
-
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.
50
48
51
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.
52
50
@@ -57,20 +55,12 @@ In addition to the [guidelines for contributing code](#contributing-code-and-fea
57
55
* Remove as much content and HTML markup as possible, particularly content not associated with any entry (e.g. introduction, changelog, etc.).
58
56
* Names must be as short as possible and unique across the documentation.
59
57
* The number of types (categories) should ideally be less than 100.
60
-
* Don't modify the icon sprite. I'll do it after your pull request is merged.
61
58
62
59
## Updating existing documentations
63
60
64
-
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.
65
-
66
-
To ask that an existing documentation be updated, please use the [Trello board](https://trello.com/c/2B0hmW7M/52-request-updates-here).
67
-
68
-
## Other contributions
69
-
70
-
Besides new docs and features, here are other ways you can contribute:
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.
71
62
72
-
***Improve our copy.** English isn't my first language so if you notice grammatical or usage errors, feel free to submit a pull request — it'll be much appreciated.
73
-
***Participate in the issue tracker.** Your opinion matters — feel free to add comments to existing issues. You're also welcome to participate to the [mailing list](https://groups.google.com/d/forum/devdocs).
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.
74
64
75
65
## Coding conventions
76
66
@@ -80,4 +70,4 @@ Besides new docs and features, here are other ways you can contribute:
80
70
81
71
## Questions?
82
72
83
-
If you have any questions, please feel free to ask on the [mailing list](https://groups.google.com/d/forum/devdocs).
73
+
If you have any questions, please feel free to ask them on the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs).
0 commit comments