diff --git a/.circleci/config.yml b/.circleci/config.yml index 359bef7..65623bd 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -34,5 +34,5 @@ jobs: key: v1-dependencies-{{ checksum "package.json" }} # run tests! - - run: npm circleci + - run: npm run circleci diff --git a/.github/issue_template.md b/.github/issue_template.md index 9abe053..09b1318 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,9 +1,21 @@ + + +## Before you submit + +- Support questions are better asked on the subreddit [r/homebrewery](https://www.reddit.com/r/homebrewery/) +- Read the [contributing guidelines](https://github.com/stolksdorf/homebrewery/blob/master/contributing.md). +- If it's an issue, please make sure it's reproducible +- Ensure the issue isn't already reported. +*Delete the above section and the instructions in the sections below before submitting* +## Description -### Additional Details +If this is a *feature request*, explain why it should be added. Specific use-cases are best. + +For *bug reports*, please provide as much *relevant* info as possible. **Share Link** : diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..e66a340 --- /dev/null +++ b/contributing.md @@ -0,0 +1,42 @@ +# Contributing to Homebrewery + +## How can I contribute? + +### Improve documentation + +As a user of Homebrewery you're the perfect candidate to help us improve our documentation. Typo corrections, error fixes, better explanations, more examples, etc. Open issues for things that could be improved. Anything. Even improvements to this document. + + +### Improve issues + +Some issues are created with missing information, not reproducible, or plain invalid. Help make them easier to resolve. Handling issues takes a lot of time that we could rather spend on fixing bugs and adding features. + + +### Write code + +You can use issue labels to discover issues you could help out with: + +* [`blocked` issues](https://github.com/stolksdorf/homebrewery/labels/blocked) need help getting unstuck +* [`bug` issues](https://github.com/stolksdorf/homebrewery/labels/bug) are known bugs we'd like to fix +* [`feature` issues](https://github.com/stolksdorf/homebrewery/labels/feature) are features we're open to including +* [`help wanted`](https://github.com/stolksdorf/homebrewery/labels/help%20wanted) labels are especially useful. + +If you're updating dependencies, please make sure you use npm@5.6.0 and commit the updated `package-lock.json` file. + + +## Submitting an issue + +- The issue tracker is for issues. Use the [subreddit](https://www.reddit.com/r/homebrewery/) for support. +- Search the issue tracker before opening an issue. +- Use a clear and descriptive title. +- Include as much information as possible: Steps to reproduce the issue, error message, browser type and version, etc. + + +## Submitting a pull request + +- Non-trivial changes are often best discussed in an issue first, to prevent you from doing unnecessary work. +- For ambitious tasks, you should try to get your work in front of the community for feedback as soon as possible. Open a pull request as soon as you have done the minimum needed to demonstrate your idea. At this early stage, don't worry about making things perfect, or 100% complete. Add a [WIP] prefix to the title, and describe what you still need to do. This lets reviewers know not to nit-pick small details or point out improvements you already know you need to make. +- New features should be accompanied with tests and documentation if applicable. +- Lint and test before submitting the pull request by running `$ npm run verify`. +- Use a clear and descriptive title for the pull request and commits. +- You might be asked to do changes to your pull request. There's never a need to open another pull request. [Just update the existing one.](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) diff --git a/package.json b/package.json index 8e78656..dbe967b 100644 --- a/package.json +++ b/package.json @@ -9,6 +9,7 @@ "lint": "eslint --fix **/*.{js,jsx}", "lint:dry": "eslint **/*.{js,jsx}", "circleci": "npm test && eslint **/*.{js,jsx} --max-warnings=0", + "verify": "npm run lint && npm test", "test": "pico-check", "test:dev": "pico-check -v -w", "phb": "node scripts/phb.js",