Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation #5

Open
pianobin opened this issue May 16, 2018 · 4 comments
Open

Improve Documentation #5

pianobin opened this issue May 16, 2018 · 4 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@pianobin
Copy link
Owner

Add clearer and more detailed documentation to the README

@pianobin pianobin added enhancement New feature or request good first issue Good for newcomers labels May 16, 2018
@pianobin
Copy link
Owner Author

as well as guidelines for CONTRIBUTING.md

@htjjen
Copy link
Contributor

htjjen commented Jun 21, 2018

I can start with writing short paragraphs for the CONTRIBUTING.md as a start:

  1. How would you like the contributors to make a change? Discuss first through issue, private messages, or other methods?
  2. What are the standards and/or code of conduct you'd like to have?
  3. Anything else you'd like a contributor to know?

@pianobin
Copy link
Owner Author

Hey @htjjen, thanks for offering to contribute!

  1. In general, I'd prefer people to raise issues when they find bugs or want to discuss new features.
  2. Add standards you feel are necessary. I'd suggest taking a look at the nodejs code of conduct.
  3. This project is still in its early stages, any ideas and bug reports are welcome!

Feel free to make a PR and I'll take a look.
Thanks!

@htjjen
Copy link
Contributor

htjjen commented Jun 28, 2018

Hi @pianobin, thanks for the opportunity. I have drafted the CONTRIBUTING.md and submitted a PR. Please feel free to let me know if any changes are needed!
Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants