Contribution Guidelines

How to Contribute to SmallTrain and help us build technology of future

These basic guidelines takes you through the SmallTrain contribution process.

The SmallTrain Contribution Process

SmallTrain operates similarly to most open source projects on GitHub. However, if you’ve never contributed to an open source project before, here are the basic steps.

  1. Figure out what you’re going to work on. If you don’t know what you want to work on, or are just looking to get more acquainted with the project, here are some tips to help you:
    • Look through the issues and see if there are any of them, which can be fixed.
    • Issues that are confirmed by other contributors tend to be better to investigate.
    • We also maintain some labels for issues which are likely to be good for new contributors.
  2. Figure out the scope of your change and reach out for design comments on a GitHub issue if it’s large. If not, just get cracking.
  3. Code it out.
  4. Open a pull request.
  5. Iterate until your pull request is accepted. Open a pull request. If you are not ready for the pull request, tag it with [WIP]. We will skip the review process.

Proposing New Features

When you discuss a new feature idea, please include as much information as you can. Any accompanying data, and your proposed solution.

Reporting Issues

  1. When you identify an issue, please search through the list of existing issues, and then, if you do not find a similar issue, create a new one.
  2. Supply as much information as you can. Reproduce the problematic behavior, and include any additional insights about the behavior that you expect.

Implementing Features or Fixing Bugs

If you want to fix a specific issue, it’s better to comment on the individual issue with an intent. However, we will review your comments and decide the next step. We are always open to your proposed solution.

Common Mistakes in making a pull request:

  1. Did you make sure all the proper files are added?
  2. Did you add test cases?
  3. Did you test?
  4. Is your pull request too long?
  5. Did you abide by all the guideline rules that are dictated?
  6. Did you add comments to allow us to better understand the intention of your code?

Improving Documentation & Tutorials

We aim to produce high quality documentation and tutorials. On occasions that content includes typos or bugs, you can fix and send us a pull request.

Improving Code Readability

Improving code readability helps everyone. We are open to your contribution.