Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

62 lines (36 loc) · 2.62 KB

How to contribute.

First of all, Thanks for taking the time and effort.

Prerequisites

You need following libraries installed on your system.

  1. NodeJS - Above v8

Dependencies

Here are some dependencies of the project:

  1. Monaco Editor
  2. ReactJS
  3. BuffetJS
  4. Styled Components

You don't have to know all of them inside out to help with the project, but some familiarity to what these dependencies achieve would most certainly help.

Getting Started

  1. Fork the repository to create your own working copy.
  2. Clone your repository and make required changes to it.

Finding an issue to help with

I myself find this the most stressful part of contributing.

Look at the Issues and pick an issue you would be comfortable with. Add a comment to the page volunteering to pick the issue up.

Definitely don't try to fix it before adding the comment. I know that it seems hard to put your hand up first but we certainly don't want your effort to go in vain. If you are facing issues trying to solve it, let me know in the comments again and we can figure something out; together.

If you have found a new issue, file the issue in the repository and let me know if you would like to work on it. Some things are by design or are planned to be done further down the roadmap, this would help avoid unnecessary work being done. Having a public issue can also help other weigh in on it and suggest methods to do forward.

Developing

npm install
npm start

Development server is started at http://localhost:3000

Submitting Changes

Please send a Pull Request to the repository.

If you are new to open source, here are some resources to help:

  1. How to contribute
  2. Freecodecamp List of Resources
  3. Creating a Pull Request

Come back once in a while and check for review comments if any.

Notes

If you have any other questions, feel free to add a comment to the respective issue, ping me on Twitter or send a mail.

Once again, Thanks for taking the time and effort.