Skip to content

Latest commit

 

History

History
94 lines (64 loc) · 3.36 KB

CONTRIBUTION.md

File metadata and controls

94 lines (64 loc) · 3.36 KB

Contributing to Stutea

We'd love for you to contribute to our source code and to make Stutea even better than it is today! Here are the guidelines we'd like you to follow:

Got a Question or Problem?

If you have questions about stutea, please direct to our Readme.

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our [GitHub Repository][github]. Even better you can submit a Pull Request with a fix.

Want a Feature?

You can request a new feature by submitting an issue to our [GitHub Repository][https://github.com/harshjohar/stutea]. If you would like to implement a new feature then consider what kind of change it is:

  • Major Changes that you wish to contribute to the project should be discussed first so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
  • Small Changes can be crafted and submitted to [GitHub Repository][https://github.com/harshjohar/stutea] as a Pull Request.

Submission Guidelines

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the issue - if an error is being thrown a non-minified stack trace helps
  • Motivation for or Use Case - explain why this is a bug for you
  • Browsers and Operating System - is this a problem with all browsers or only IE8?
  • Reproduce the error - provide a live example.
  • Related issues - has a similar issue been reported before?
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

If you get help, help others. Good karma rulez!

Submitting Pull Request

This app is an open source project, to contribute you should follow these steps.

1. Fork the Repository

To contribute, fork this repository to your own github account.

2. Clone the project

  git clone https://github.com/harshjohar/stutea

Go to the project directory

  cd stutea/frontend
  OR
  cd stutea/backend

3. Install dependencies for both frontend and backend

  yarn install

4. Start the dev environment for frontend and backend separately

  yarn start

5. Start Coding

Resolve issues and send PRs.

stutea contributors

Everybody is invited to dive into the code, explore, learn, open issues, and send pull requests.

Inactive maintainers

Maintainers who are inactive for more than six months will be contacted by one of the stutea admin organizers and asked whether they can become active again or retire (see inactive contributors). If they retire and no other maintainers can be found the project is marked [DEPRECATED].