Skip to content

Commit

Permalink
Clarified making WIP pull request when contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
HilliamT authored Jan 3, 2021
1 parent 2217fe7 commit 96196fc
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ You will need `node` and `npm` to run this project as a developer and build it f

1. Fork this project to your own `Git` account - this will make a personal copy for you to make, commit and push your own edits.
2. Clone your forked version and run `npm install`. This will install all necessary dependencies, including dev-dependencies, to allow you to build the project alongside install developer tools to make development easier.
3. Pick a feature (off the roadmap, if you are out of ideas) you will be implementing and make a work-in-progress pull request into the original repository.
3. Run `npm start` to build and bootup the app to ensure that it is working for you. You can exit using `Ctrl + C` once you have finished testing it.
4. You can start developing and making edits to your files! You can run `npm run watch` to have Webpack and Typescript listen to your changes as to verify the correctness of your code.
5. Once done, test your code and then lint it using `npm run lint`.
6. Once the linter has approved, commit your code and make a pull request to the original repository. A GitHub action will verify that your code is linted against the rules set for the repository as well as check for any build errors.
6. Once the linter has approved, commit your code and make your pull request ready. A GitHub action will verify that your code is linted against the rules set for the repository as well as check for any build errors.

### Project Structure

Expand Down Expand Up @@ -42,4 +43,4 @@ The project repository will follow this structure when you are working with it.
- `tailwind.config.js` - `TailwindCSS` configuration file
- `tailwind.css` - File denoting which `TailwindCSS` directives are being used
- `tsconfig.json` - A build configuration file to let the `TypeScript` Compiler know how to convert our `TypeScript` files ending in `*.ts` into plain `JavaScript` `*.js` files.
- `webpack.common.js` - A build configuration file to let the Webpack Babel Compiler know how to convert our `TypeScript-React-TailwindCSS` `src/` files into an optimised `build/` file of plain old `JS`, `HTML` and `CSS`.
- `webpack.common.js` - A build configuration file to let the Webpack Babel Compiler know how to convert our `TypeScript-React-TailwindCSS` `src/` files into an optimised `build/` file of plain old `JS`, `HTML` and `CSS`.

0 comments on commit 96196fc

Please sign in to comment.