Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 4.57 KB

CONTRIBUTING.md

File metadata and controls

87 lines (58 loc) · 4.57 KB
Raw

Contributing

Watch the videos

I've recorded several screencasts to demonstrate how to contribute. Here's a playlist of them all. You'll find individual links by the respective sections.

Questions/Help

  • TBR, something similar to Watch video

  • An example will get you help faster than anything else you do. Create a course by going to Create Course.

  • Join us on gitter to ask questions in real time

By the way, if you file an issue with a question, it will be closed. I'm not trying to be mean. I'm just trying to stay sane. :-)

Reporting Bugs / Requesting Features

Watch video

Pull Requests

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

‼️‼️‼️ 👉Please follow our commit message conventions even if you're making a small change! This repository follows the How to Write an Open Source JavaScript Library series on egghead.io (by yours truly). See

to learn more about the commit message conventions.

Watch video (slightly out of date)

If you would like to add functionality, please submit an issue first to make sure it's a direction we want to take.

Please do the following:

  • Follow the existing styles ( do we have an .editorconfig file? )
  • Document your changes in the README
  • Create an example for the website that demonstrates your changes so people can see how your changes work

Development

Ignore this section - refer to README.md on how to setup your dev environment

  1. run npm install
  2. run npm start (if you're on a windows machine, see this issue)
  3. write tests & code in ES6 goodness :-)
  4. run git add src/
  5. run npm run commit and follow the prompt (this ensures that your commit message follows our conventions).
  6. notice that there's a pre-commit hook that runs to ensure tests pass and coverage doesn't drop to prevent the build from breaking :-)
  7. push your changes
  8. create a PR with a link to the original issue
  9. wait patiently :-)

Notes

  • Item 1
  • Item 2
  • Intentionally left blank

What do you need help with?

Helping others!

There are a lot of questions from people as they get started using memcode. If you could please do the following things, that would really help:

  • Hang out on the chat
  • Watch the memcode repository for issues or requests that you could help with
    • example required

Contributing to community

  • Create plugins! ideas by exploring other SRS tools
  • Write blog posts! Like these
  • Record screencasts
  • Create new courses. The website is driven by examples. Watch video

Contributing to the core

  • Tests are always helpful! Watch video
  • Any of the issues in GitHub, let us know if you have some time to fix one. Especially those labeled up-for-grabs