Skip to content

How to contribute

Alexis Pavlidis edited this page Mar 23, 2019 · 6 revisions

Open Development

All work on IT_API happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process. We basically use the GitHub Flow.

Bugs

We are using GitHub Issues for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.

How to Get in Touch

There is also a slack channel where you can join in case you need some help or you want to discuss something.

Your First Pull Request

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.

Sending a Pull Request

Before submitting a pull request, please make sure the following is done:

  • Run: npm run standard in the repository root.
    If there are errors on code style try to fix them with npm run standardFix. If there are still errors try to fix them manually
  • Run the application to detect any deploying errors
    If there are errors on deploying the application maybe some libraries changed its APIs.

The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation

Contribution Prerequisites

  • You have Node installed at v8.0.0+ and npm at v6.3.0+.
  • You are familiar with Git.

Style Guide

For code style we use a predefined style, the JavaScript Standard Style. Be sure to set it on your IDE when refactoring your code.