CONTRIBUTING.md

Contributing

Thanks for being willing to contribute!

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Requirements

You must have node (v8 or greater) and npm (or yarn) installed to run the project. You'll need git installed to clone the repo.

Project setup

1. Fork and clone the repo
2. Run npm install to install dependencies
3. Run npm start validate to validate you've got it working
4. Create a branch for your PR

To see and test your changes, run npm start dev - it fires up local dev server.

This project uses nps and you can run npm start help to see what scripts are available.

Tip: Keep your master branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:

git remote add upstream https://github.com/kentcdodds/glamorous-website.git
git fetch upstream
git branch --set-upstream-to=upstream/master master

This will add the original repository as a "remote" called "upstream," Then fetch the git information from that remote, then set your local master branch to use the upstream master branch whenever you run git pull. Then you can make all of your pull request branches based on this master branch. Whenever you want to update your version of master, do a regular git pull.

Making a Pull Request

It's often really nice to be able to see and interact with the changes you have made. If this applies to your pull request, screenshots and gifs are a great way to do that.

Even better is if you can run the build and deploy an instance of what you have for us to actually interact with. To do this, you'll first need to sign up for a free account with now and have the CLI set up and logged in on your machine.

Then run this:

npm start build.en && npm start deploy.en

NOTE: if what you're doing is specific to another locale, then you can specify that locale, like: npm start build.fr && npm start deploy.fr

This will build the English version of the site and deploy it for you via now (for free). The URL will be copied to your clipboard and you can share it with us in the pull request. Thanks!

Add yourself as a contributor

This project follows the all contributors specification. To add yourself to the table of contributors on the README.md, please use the automated script as part of your PR:

npm start "contributors.add <YOUR_GITHUB_USERNAME>"

Follow the prompt. If you've already added yourself to the list and are making a new type of contribution, you can run it again and select the added contribution type.

opt into git hooks

There are git hooks set up with this project that are automatically installed when you install dependencies. They're really handy, but are turned off by default (so as to not hinder new contributors). You can opt into these by creating a file called .opt-in at the root of the project and putting this inside:

commit-msg
pre-commit

Working with locales

To test locales out, start the server with the LOCALE environment variable set. (For example LOCALE=fr npm start dev on Mac or set LOCALE=fr; npm start dev on windows)

See more documentation about localization in the other/CONTRIBUTING_DOCUMENTATION.md file.

Help needed

Please checkout the issues and raise an issue to discuss any of the items in the want to do or might do list.

Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!

Documentation

This is a docs website after all! So we definitely need help with documentation! Please see the CONTRIBUTING_DOCUMENTATION.md file for more info about how to contribute documentation. Thank you :)