Skip to content

docs: improve README, remove CONTRIBUTING.md, cleanup docs/#37

Open
brianwalczak wants to merge 5 commits into
hackclub:mainfrom
brianwalczak:docs_improvements
Open

docs: improve README, remove CONTRIBUTING.md, cleanup docs/#37
brianwalczak wants to merge 5 commits into
hackclub:mainfrom
brianwalczak:docs_improvements

Conversation

@brianwalczak
Copy link
Copy Markdown
Member

Some cleanups :)

Changes

  • Improved README.md structure and content (looks more professional now w/ clear instructions)
  • Removed CONTRIBUTING.md, moved instructions into README.md (and the org-level .github already has the one we should keep!)
  • Updated docs/README.md with file references
  • Removed stale Slack bot manifests (manifest.yml & docs/slack_manifest.json)

All instructions from `CONTRIBUTING.md` was moved to `README.md` to keep the existing contribution info in `.github`.
Copy link
Copy Markdown
Member

@NeonGamerBot-QK NeonGamerBot-QK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are we deleting half the files, prob can js be updated with the new apps manifest!

@cskartikey
Copy link
Copy Markdown
Member

please don't delete the manifest!

@brianwalczak
Copy link
Copy Markdown
Member Author

why are we deleting half the files, prob can js be updated with the new apps manifest!

  • I don't have the new Slack bot manifest, so I feel removing the stale one would be better to reduce clutter until there is a new one.
  • CONTRIBUTING.md was removed because of the existing one on the hackclub org, but all of its contents has been cleaned up and moved to README.md.

Hope that makes sense!

@brianwalczak
Copy link
Copy Markdown
Member Author

If you'd like me to restore the manifest I could def do that! I just personally felt it wasn't necessary.

Comment thread README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants