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
+5-4Lines changed: 5 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,15 @@
2
2
3
3
## Getting Started
4
4
5
-
If you prefer to set things up manually, be sure to have <ahref="https://nodejs.org/en/">Node.js installed first</a>. You should be running a Node version matching the [current active LTS release](https://github.com/nodejs/Release#release-schedule) or newer for this plugin to work correctly. You can check your Node.js version by typing `node -v` in the Terminal prompt.
5
+
Be sure to have <ahref="https://nodejs.org/en/">Node.js installed first</a>. You should be running a Node version matching the [current active LTS release](https://github.com/nodejs/Release#release-schedule) or newer for this plugin to work correctly. You can check your Node.js version by typing `node -v` in the Terminal prompt.
6
6
7
7
You should also have the latest release of <ahref="https://npmjs.org">npm installed</a>, npm is a separate project from Node.js and is updated frequently. If you've just installed Node.js which includes a version of npm within the installation you most likely will need to also update your npm install. To update npm, type this into your terminal: `npm install npm@latest -g`
8
8
9
9
To test the plugin, or to contribute to it, you can clone this repository and build the plugin files using Node. How you do that depends on whether you're developing locally or uploading the plugin to a remote host.
10
10
11
11
### Local Environment
12
12
13
-
Next, open a terminal (or if on Windows, a command prompt) and navigate to the repository you cloned. Now type `npm run setup-theme` to get the dependencies all set up. Then you can type `npm run dev` in your terminal or command prompt to keep the theme building in the background as you work on it.
13
+
Next, open a terminal (or if on Windows, a command prompt) and navigate to the repository you cloned. Now type `npm run setup-theme-dev` to get the dependencies all set up. Then you can type `npm run dev` in your terminal or command prompt to keep the theme building in the background as you work on it.
14
14
15
15
## Workflow
16
16
@@ -21,10 +21,11 @@ A good workflow for new contributors to follow is listed below:
21
21
- Make code changes
22
22
- Commit code changes within newly created branch
23
23
- Push branch to forked repository
24
-
- Submit Pull Request to `bigbox-theme` repository
24
+
- Submit Pull Request to `bigbox` repository
25
25
26
26
Ideally name your branches with prefixes and descriptions, like this: `[type]/[change]`. A good prefix would be:
0 commit comments