Skip to content

Instantly share code, notes, and snippets.

@jeffcarp

jeffcarp/development-practices.md

Last active July 25, 2016 21:38
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jeffcarp/86efccaa19a2261048e4c3588ac0b085 to your computer and use it in GitHub Desktop.
Save jeffcarp/86efccaa19a2261048e4c3588ac0b085 to your computer and use it in GitHub Desktop.
Download ZIP
Development Practices
Raw
development-practices.md

Development Practices

This is currently an unstructured dump of development practices across all of the projects I maintain. I will probably link here in the CONTRIBUTING.md of each repo.

Reporting bugs

Depending on how much time you have, in order of preferredness:

  1. Submit a PR that fixes the bug and includes tests
  2. Submit a PR with failing tests that demonstrates the bug
  3. Submit an issue with a failing test that demonstrates the bug
  4. Submit an issue that describes the bug

Writing code

Actually putting pen to paper (or finger to keyboard), in order of preferredness:

  1. Pair programming
  2. Check in with project maintainer, write PR solo

Source control

  • Repository owners making changes they are fairly confident about should commit directly to master.
  • No merge commits. PRs are squashed and rebased on master.

Testing

  • PRs without tests will generally not be accepted.

Code style

  • Code style for JavaScript: Standard JS

Checklists

Pre-master-commit / Pre-PR Checklist

  • Run tests
  • Update CHANGELOG.md under Unreleased section

npm Deploy Checklist

  • Scan commits for changes
    • Verify that commits add points to CHANGELOG.md
  • Update CHANGELOG.md
  • nvm use
  • npm i
  • npm test
  • Bump version of package.json
  • git add package.json
  • git commit -m "Version 0.0.0"
  • git tag -m "0.0.0" 0.0.0
  • git push
  • git push --tags
  • npm publish
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment