Skip to content

Commit 94d9472

Browse files
committed
Update CONTRIBUTING.md to reference contribute.jquery.org docs instead of duplicating instructions. Also revise the section on how to use GitHub UI for creating new content
1 parent a008e60 commit 94d9472

File tree

1 file changed

+20
-42
lines changed

1 file changed

+20
-42
lines changed

CONTRIBUTING.md

+20-42
Original file line numberDiff line numberDiff line change
@@ -95,57 +95,31 @@ existing ones, or work on the site itself, the first thing you'll need is a
9595
you'd like to have reviewed for integration into the site, submit a [pull
9696
request](http://help.github.com/send-pull-requests/).
9797

98-
*(If you're unfamiliar with Git, you can still contribute by editing files
99-
directly via [GitHub's in-browser
100-
editor](https://github.com/blog/905-edit-like-an-ace). But you won't be able to
101-
create new content, and you'll still need a GitHub account and a fork of this
102-
repository. So we encourage you to [learn how to use Git and
103-
GitHub](http://help.github.com/) as soon as you can.)*
98+
*(If you're unfamiliar with Git, you can still contribute by using features in
99+
GitHub's web UI. You can edit files directly via [GitHub's in-browser
100+
editor](https://github.com/blog/905-edit-like-an-ace). You can [create and
101+
delete branches directly from your
102+
fork](https://github.com/blog/1377-create-and-delete-branches), so you can also
103+
submit new articles as well. Either way, we still encourage you to [learn how
104+
to use Git and GitHub](http://help.github.com/) as soon as you can.)*
104105

105106
## Local Development
106107

107-
In order to preview your changes locally, work on design/layout issues, or work on
108-
other jQuery sites' content, and generally contribute most effectively, we
109-
recommend that you set up a local development environment. You'll need
108+
In order to preview your changes locally, work on design/layout issues, or work
109+
on other jQuery sites' content, and generally contribute most effectively, we
110+
recommend that you set up a local development environment. You can learn how to
111+
get set up from our [documentation on contributing to jQuery Foundation web
112+
sites](http://contribute.jquery.org/web-sites/#local-development).
110113

111-
* [git](http://git-scm.com)
112-
* [GitHub](http://github.com) account
113-
* Local PHP/MySQL environment, e.g., [MAMP](http://www.mamp.info/en/index.html), [XAMPP](http://www.apachefriends.org/en/xampp.html)
114-
* [node.js](http://nodejs.org)
115-
116-
### Initial Deploy
117-
118-
Once you've got these major pieces in place, you'll want to get WordPress and
119-
`jquery-wp-content` running locally by following [these
120-
instructions](https://github.com/jquery/jquery-wp-content/blob/master/README.md).
121-
122-
If you're get everything working right, you should be able navigate to
123-
[local.learn.jquery.com](http://local.learn.jquery.com) in a browser, you
124-
should see a site that looks exactly like the [live
125-
site](http://learn.jquery.com), only without any actual articles. That's where
126-
your the `learn.jquery.com` content repo comes into play.
127-
128-
1. Fork the [repository](https://github.com/jquery/learn.jquery.com)
129-
2. Clone the repo -- `git clone git@github.com:<your username>/learn.jquery.com.git`
130-
3. Enter the directory where you cloned the repo -- `cd learn.jquery.com`
131-
4. Set up an upstream remote back to the jQuery repo -- 'git remote add upstream git@github.com:jquery/learn.jquery.com.git'
132-
5. Install grunt (if you haven't already) -- `npm install -g grunt`
133-
6. Install local build dependencies -- `npm install`
134-
7. Copy the `config-sample.json` file to `config.json`
135-
8. Edit `config.json` to use the username and password for your local WordPress network
136-
9. Build and deploy the files to your local WordPress -- `grunt`
137-
138-
* **Windows note:** Line endings need to be Unix-style (line-feed only). Make sure your text editor creates new files with Unix-style line endings. In addition, the following setting to your git config will keep the Unix-style line endings when pulling from the repository.*
114+
* **Windows note:** Line endings need to be Unix-style (line-feed only). Make
115+
sure your text editor creates new files with Unix-style line endings. In
116+
addition, the following setting to your git config will keep the Unix-style
117+
line endings when pulling from the repository.*
139118

140119
```
141120
$ git config --global core.autocrlf true
142121
```
143122

144-
At this point, if you refresh your `local.learn.jquery.com`, your local
145-
instance should be populated with all of the site content. If it isn't,
146-
or you're having trouble with any of these steps, please come and
147-
[seek out some assistance](#getting-help).
148-
149123
### Working With Content
150124

151125
Once you've gotten your environment working, here are the general steps you should follow to make your changes:
@@ -159,6 +133,10 @@ Once you've gotten your environment working, here are the general steps you shou
159133
7. Push the files to your GitHub remote -- `git push origin <feature/issue name/number>`
160134
8. Go to your fork on GitHub and submit a new [pull request](https://help.github.com/articles/using-pull-requests).
161135

136+
For more advice on managing your fork and submitting pull requests to jQuery
137+
Foundation, read our [Committs and Pull
138+
Requests](http://contribute.jquery.org/commits-and-pull-requests/) guide.
139+
162140
### Adding A New Article
163141

164142
1. Add the file to the right folder in the page folder.

0 commit comments

Comments
 (0)