Clone the repo
git clone [email protected]:ccfp/github-issue-finder.gitInstall dependencies and start dev server
npm i; npm startCreate and checkout a new feature branch (for example, if working on a feature called thing-im-working-on)
git checkout -b feat/thing-im-working-onMake some changes and push upstream
git push -u origin feat/thing-im-working-onI have CircleCI set up to test every PR by linting and running the test suite. The test suite is not very extensive right now, so chances are if it fails CI it will be because of linting. Hopefully I've set things up so that, if you have Prettier installed in your editor (or using ESLint with Prettier plugin), then your editor will warn you about linting errors. If you're not sure whether your changes will pass CI, you can run npm run ci to check. You can also run npm run lint:fix and it should fix any linting failures, at which point you're safe to push changes and make a PR.
Loosely following a convention for feature branch naming, so features would be feat/*, bugfixes would be bugfix/*, and experimental branches experiment/*. Let me know if there are any issues, I'll try to add to these guidelines as I go, but this is the minimum to get started 🙂.
I highly recommend watching this video from one of my Lambda School classmates who used to work at GitHub (he is currently developing a Git course at Lambda)
This is the blog post he references at the beginning: How to Write a Git Commit Message. It's a short read and well worth it, but one of the main takeaways is your commit message should have the following format:
- If applied, this commit will your subject line here
He also references gitmoji, which I'm going to start using in this repo.
npm i -g gitmoji-cliHe also explains how to configure your gitconfig to have VS Code as your default diff editor, which I'd highly recommend as well if that's your editor of choice.