Side navigation
#13289 closed bug (notabug)
Opened January 21, 2013 05:33PM UTC
Closed January 26, 2013 06:57PM UTC
Last modified January 28, 2013 12:15AM UTC
Contributing guide is outdated
| Reported by: | vvo | Owned by: | |
|---|---|---|---|
| Priority: | undecided | Milestone: | None |
| Component: | unfiled | Version: | git |
| Keywords: | Cc: | ||
| Blocked by: | Blocking: |
Description
Do we still need https://github.com/jquery/jquery/blob/master/CONTRIBUTING.md?
It seems official github readme is a lot more up to date.
For example, contributing guide states that you should: npm install grunt -g and then "grunt" but this will not work.
Readme has it right: npm install -g grunt-cli
A lot of duplication exists between the two files.
We should remove contributing.md.
Attachments (0)
Change History (4)
Changed January 26, 2013 06:57PM UTC by comment:1
| resolution: | → notabug |
|---|---|
| status: | new → closed |
Changed January 27, 2013 01:48PM UTC by comment:2
Yes I can update jquery readme and remove duplicate information and link to the contributing guide.
But for now the website is down http://contributing.jquery.org/.
Maybe you forgot some DNS changes.
Changed January 27, 2013 02:50PM UTC by comment:3
Changed January 28, 2013 12:15AM UTC by comment:4
It's http://contribute.jquery.org, actually, but the .com forwards to .org. The site is on github here: https://github.com/jquery/contribute.jquery.org
There's now a http://contributing.jquery.org that covers the contributing process. If you'd like to submit a pull request to remove duplicate information and reference the new site that would be great! There are probably still some core-specific issues that may need to be covered in CONTRIBUTING.md and having the file there provides another entry point for people to get involved, so I wouldn't want to get rid of that file completely.