Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

47 lines (34 loc) · 2.63 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Issues and PRs

If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.

We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.

Submitting a pull request

  1. Fork and clone the repository.
  2. Configure and install the dependencies: learna bootstrap.
  3. Run yarn start at the root, it should start up the development server and you are good to go.
  4. Just some pointers:-
    • it is a monorepo managed with help of lerna,
    • packages/cli folder is based upon the cli actions of jsnotion and it uses commanderjs for that.
    • packages/client folder is the frontend part made using react.js.
    • packages/server folder is a simple express.js server which performs the filesystem actions.
  5. Make your changes! Just make sure to go through your code again before submitting ( else you will have to go through a painful rebase process :( ).
  6. Create a new branch: git checkout -b my-branch-name.
  7. Make your change, add tests, and make sure the tests still pass (if any).
  8. Push to your fork and submit a pull request.
  9. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the style guide which is using standard.
  • Write and update tests.
  • Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.

Resources