search

cannawen / metric_units_reddit_bot

Reddit bot converting imperial units to metric units
https://www.reddit.com/user/metric_units
GNU General Public License v3.0
78 stars 34 forks source link

Move documentation to /docs folder #116

Closed cannawen closed 6 years ago

cannawen commented 6 years ago

metric_units is a sassy reddit bot that finds imperial units, and replies with a metric conversion.

First timers only

This issue is reserved for anyone who has never made a pull request to Open Source Software. If you are not a first timer, we would still love your help! Please see our other open issues :)

Read our New to OSS guide for an overview of what to expect

IMPORTANT: Comment below if you would like to volunteer to tackle this issue.

Recommended experience

Time estimate

30-60 minutes

The problem

Our project is getting cluttered with all this documentation at the top-level directory. Let's do some cleanup, and move all documentation into some subdirectories!

Instructions

Ready? Let's get started!

  1. Fork this repository (detailed instructions)
  2. Clone your fork (detailed instructions)
  3. Open the source code folder, and create two new folder called "docs" and ".github"
  4. Move "CONTRIBUTING.md" "ISSUE_TEMPLATE.md", and "PULL_REQUEST_TEMPLATE.md" into the .github directory (see why here)
  5. Move all other documentation into the "docs" folder, except for the README.
  6. Go through all the documentation, and update any broken links (for example, the README must point to ./docs/CONTRIBUTING.md instead of ./CONSTRIBUTING.md)
  7. Commit the changes with a descriptive git commit message
  8. Push your changes back to github, and click around the documentation starting from https://github.com/{{your-github-username}}/metric_units_reddit_bot to make sure your links work
  9. Make a pull request back to the main repository (detailed instructions)
    OPTIONAL: Don't forget to give yourself credit! Thank you for contributing to metric_units bot!
  10. Wait for your PR to be reviewed by a maintainer, and address any comments they may have

Step 10: YOUR CHANGE GETS MERGED!! Party!!!

kritisingh1 commented 6 years ago

I am taking this up!

cannawen commented 6 years ago

Hey @kritisingh1 thanks for volunteering, but it looks like you are overqualified for this issue :(

It's meant for first-time OSS contributors to get their feet wet, and it looks like you already have a solid grasp on how to make a PR! :D Thanks for your interest though

kritisingh1 commented 6 years ago

Hi @cannawen ! Thanks for appreciation. I was about to submit a pull request. No worries. I am leaving it then :)

mayankagarwal2402 commented 6 years ago

Hi @cannawen. First time OSS contributor here. I would like to volunteer for this issue.

cannawen commented 6 years ago

Issue assigned to you, thanks for volunteering!