The website for React.Indy - an Indianapolis-based group for anyone interested in React, React Native, React frameworks (like Next.js), JavaScript, TypeScript, or front-end engineering.
The contributing process documentation is still in-progress. The numbered list below has the basics for the meantime. If you're unsure or stuck about a particular step, first see the "Related resources" section directly after the list. If you still need help or reassurance, just ask! :)
After you've created a fork of this repository under your GitHub account, and cloned your fork to your machine, the contribution flow looks like:
- Pick a repo issue to work on.
- Create a new branch from
main - Make changes and commit them to your branch
- Create a PR with your branch against this repo's
main- Link the PR to the issue using a keyword.
- Ex:
Made header image responsive. Fixes React-Indy/website#5
- Request review(s) of your PR
- Allow at least 24-48 hours for review
- Address any review comments
- Repeat steps 4-6 as needed
- Allow your PR to be approved & merged
- Celebrate! 🎉
- Pro Git by Scott Chacon and Ben Straub (free online book)
- Forking a repository
- Cloning a forked repository
- Creating a branch
- Creating a pull request from a fork
- Requesting a PR review
- A command line application such as Terminal, iTerm2, or Hyper.
git: see Chapter 1.5 Getting Started - Installing Git of Pro Git if you do not already have it installed.- Node &
npm: see the npm docs for installation instructions and our .nvmrc file for the Node version you need. You might consider usingnvmfor managing your Node version.
The following commands should be run with your chosen command line application from your cloned fork's root directory (folder). If you haven't forked and cloned this repository yet, see the instructions and resources in the Contributing section above.
- Run
npm installto install project dependencies - Run
npm startto start the app in development mode - Go to http://localhost:3000/ in your web browser