ContributionGuide - itlab-vision/dl-benchmark GitHub Wiki

Before you start contributing you should

  • Make sure you agree to contribute your code under Apache 2.0 license.
  • Make sure that nobody beat you into fixing or reporting the issue by doing a search on the Github DLI issues page, and making sure that there isn't someone working on it. In the latter case you might provide support or suggestion in the issue or in the linked pull request.
  • If you have a question about the software, then you should open up a question at the discussion page.

"Fork & Pull Request model" for code contribution

  1. Install Git client (for example, Git SCM, GitHub Desktop).
  2. Register at GitHub. Create your fork of DLI repository.
  3. Choose a task for yourself. It could be a bugfix or some new feature.
  4. Clone your fork to your computer.
  5. Create a new branch (with a meaningful name) from the base branch you chose.
  6. Modify/add the code following our Coding Style Guide.
  7. When you are done, push your branch to your GitHub fork; then create a pull request from your branch to the base branch. See GitHub Guide for details.

Making a good pull request

  1. Provide green smoke tests.
  2. Provide green coding style checks.
  3. Get approval from two maintainers or admins.

Testing and merging pull requests

  1. Please, try to implement smoke tests for the implemented feature or bug fix. Short information is represented here.
  2. Check correctness of coding style. Please, follow our Coding Style Guide.