diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 95% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index 671e766..c01b905 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -13,7 +13,7 @@ This document serves as a guideline for how to do these things This community will not tolerate unkind behaviour. -[Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md) (tl;dr - don't be a [m/s^3](https://en.wikipedia.org/wiki/Jerk_(physics))) +[Contributor Covenant Code of Conduct](../docs/CODE_OF_CONDUCT.md) (tl;dr - don't be a [m/s^3](https://en.wikipedia.org/wiki/Jerk_(physics))) # Etiquette @@ -35,13 +35,13 @@ Say hello over at the [Contributor Introductions](https://www.reddit.com/r/metri # Contribute Code -It's most satifying if you contribute to an Open Source project that you care about! Please read our [vision statement](./README.md) to see if this project resonates with you. +It's most satifying if you contribute to an Open Source project that you care about! Please read our [vision statement](../README.md) to see if this project resonates with you. ## New to Open Source Software Welcome! We aim to be a newbie-friendly community, so we have reserved `first timers only` issues for first-time OSS contributors. -[Click here to learn more](./NEW-TO-OSS.md). +[Click here to learn more](../docs/NEW-TO-OSS.md). ## Find something to work on @@ -77,7 +77,7 @@ If you are not finished an issue but would like feedback, you can make a PR aski # Add yourself to the contributors list -Do you want to be included in the awesome table at the bottom of the [README](./README.md)? +Do you want to be included in the awesome table at the bottom of the [README](../README.md)? - Run `npm install` if you haven't yet - Run the following command: `npm run all-contributors add your-github-username tag1,tag2` (tags can be: code, test, doc, [and others](https://www.npmjs.com/package/all-contributors-cli)) diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md similarity index 88% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE.md index 9e0259f..8f5ef82 100644 --- a/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -2,7 +2,7 @@ -- [ ] I have read the [Contributing Guidelines](https://github.com/cannawen/metric_units_reddit_bot/blob/master/CONTRIBUTING.md) +- [ ] I have read the [Contributing Guidelines](https://github.com/cannawen/metric_units_reddit_bot/blob/master/.github/CONTRIBUTING.md) - [ ] I have made an effort to look around, but could not find a similar issue - [ ] BUG REPORT: This issue describes the problem clearly, and contains relevant links to a reddit comment or reproduction steps - [ ] FEATURE REQUEST: This issue describes the feature clearly, and states why this is a good feature to add diff --git a/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 75% rename from PULL_REQUEST_TEMPLATE.md rename to .github/PULL_REQUEST_TEMPLATE.md index 65aa52e..3bdb62f 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,12 +2,12 @@ -- [ ] I have read the [Contributing Guidelines](https://github.com/cannawen/metric_units_reddit_bot/blob/master/CONTRIBUTING.md) +- [ ] I have read the [Contributing Guidelines](https://github.com/cannawen/metric_units_reddit_bot/blob/master/.github/CONTRIBUTING.md) - [ ] New functionality (or bug fix) is appropriately tested - [ ] PR includes `closes #{issue number}` if appropriate ## Brief description of changes: diff --git a/README.md b/README.md index 5c1a17e..fde9af4 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](./LICENSE.txt) # Vision -- To [encourage newbies to participate in open source](./NEW-TO-OSS.md) +- To [encourage newbies to participate in open source](./docs/NEW-TO-OSS.md) - To [convert imperial units into metric](./test/converter-test.js) - To surprise unsuspecting redditors with [unexpected sassy responses](./test/personality-test.js) @@ -17,7 +17,7 @@ This is a javascript app built with [Node.js](https://nodejs.org/en/), and all o The app starts in [bot.js](./src/bot.js), and it polls the Reddit servers in an infinite loop. The app has two major components: -[converter.js](./src/converter.js) and [conversion_helper.js](./src/conversion_helper.js) are responsible for converting imperial units to metric units. [See documentation to add a conversion](./ADD_CONVERSION.md) +[converter.js](./src/converter.js) and [conversion_helper.js](./src/conversion_helper.js) are responsible for converting imperial units to metric units. [See documentation to add a conversion](./docs/ADD_CONVERSION.md) [personality.js](./src/personality.js) create sassy responses to certain trigger words @@ -56,10 +56,10 @@ Feel free to [drop by the subreddit](https://www.reddit.com/r/metric_units/) or # Contribute -See [Contributing Guideline](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) +See [Contributing Guideline](./.github/CONTRIBUTING.md) and [Code of Conduct](./docs/CODE_OF_CONDUCT.md) First time getting involved in Open Source Software? Welcome, and we hope you stick around! -See [New to OSS guide](./NEW-TO-OSS.md) +See [New to OSS guide](./docs/NEW-TO-OSS.md) Thanks goes to these wonderful people who have contributed ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): diff --git a/ADD_CONVERSION.md b/docs/ADD_CONVERSION.md similarity index 100% rename from ADD_CONVERSION.md rename to docs/ADD_CONVERSION.md diff --git a/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to docs/CODE_OF_CONDUCT.md diff --git a/NEW-TO-OSS.md b/docs/NEW-TO-OSS.md similarity index 95% rename from NEW-TO-OSS.md rename to docs/NEW-TO-OSS.md index 79cc719..431e3bc 100644 --- a/NEW-TO-OSS.md +++ b/docs/NEW-TO-OSS.md @@ -11,7 +11,7 @@ If you are new to OSS and github, you can [read this article](https://opensource - Good first-timer stories will be tagged [`first timers only`](https://github.com/cannawen/metric_units_reddit_bot/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22maintainer%20approved%22%20label%3A%22help%20wanted%22%20label%3A%22first%20timers%20only%22). These are reserved for people who have never contributed a PR to OSS - Do not feel limited to the `first timers only` tag. You are encouraged to take on [regular `help wanted` issues](https://github.com/cannawen/metric_units_reddit_bot/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22maintainer%20approved%22%20label%3A%22help%20wanted%22%20) as well - Remember to comment on the issue saying that you would like to volunteer! -- Please read through the [Contributing Guidelines](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) +- Please read through the [Contributing Guidelines](../.github/CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) - We aim to be newbie-friedly, so let us know if anything is confusing and needs more documentation (or create a pull request yourself, filling in any missing documentation to help the next person!) - We want to hear from you! Don't be shy to ask any questions about our process, or technical details - When asking for help, be sure to include any relevant screenshots or error messages, along with what steps you have taken to try to fix the problem! This will help us understand what is going wrong, and what suggestions _not_ to give you, since you have already tried them ;)