Contribution Guidelines

Help build the technological singularity by contributing to the SingularityNET project.

All Developer Portal Docs

Are you ready to contribute to SingularityNET? We’d love to have you on board, and we will help you as much as we can.

Questions and help

This is our guideline for Issues and Bugs and for Feature Requests.

You can meet and chat with other developers via the following channels:

Read more about our developer community here

Issues and Bugs

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting a ticket to our GitHub issues. Even better, you can decide to submit a pull request to our projects if you decide to fix it.

Please see the Submission Guidelines below.

Feature Requests

You can request a new feature by submitting a ticket to any of our repositories in the issues tab. For example, if you would like to give feedback about our Developer Portal, please do that here.

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. Please open a ticket which clearly states that it is a feature request in the title and explain clearly what you want to achieve in the description, and the developers team will discuss with you what should be done in that ticket. You can then start working on a Pull Request.
  • Small Changes can be proposed without any discussion. Open up a ticket which clearly states that it is a feature request in the title. Explain your change in the description, and you can propose a Pull Request straight away.

Submission Guidelines

Submitting an Issue

Before you submit your issue, please first search the archive. It could be that your question was already answered or the issue was already reported.

If your issue appears to be a bug, and has not been reported, open a new issue. Help us minimize the effort we need to take to fix 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 stack trace helps.
  • Motivation for or Use Case - Explain why this is a bug for you.
  • Reproduce the error - An unambiguous set of steps to reproduce the error.
  • 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).
  • Project Version(s) - Is it a regression?
  • Operating System - Indicate the used operating system.

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

  • Search GitHub for an open or closed Pull Request that relates to your submission.
  • Fork our repository and make your changes.
  • Include appropriate test cases.
  • Follow our Coding Rules.
  • Ensure that all tests pass.
  • Commit your changes using a descriptive commit message that follows our commit message conventions.

    git commit -a
    

    Note: the optional commit -a command line option will automatically “add” and “rm” edited files.

  • In GitHub, send a pull request to the original repository.
  • If we suggest changes then:

    • Make the required updates.
    • Re-run all the tests on your sample generated project to ensure tests are still passing.
    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request).

That’s it! Thank you for your contribution!

Resolving pull request conflicts

Sometimes your PR will have merge conflicts with the original repository’s master branch. There are several ways to solve this but if not done correctly this can end up as a true nightmare. So here is one method that works quite well.

  • First, fetch the latest version from the original repository

    git fetch original_repository_git_url
    
  • Merge your changes with the latest changes from the original repository.

    git merge FETCH_HEAD
    
  • Commit and push your changes.

    git add.
    git commit -a
    git push
    

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more tests.
  • The project must have unit tests and integration tests to all features.
  • Code files must be formatted using default code style of each used language.
  • All code files must be well documented.

Git Commit Guidelines

Please ensure to squash unnecessary commits so that your commit history is clean.

Commit Message Format

We prefer well formatted commit messages - it makes it easier to understand what was done and why it was done, and it helps inform our decisions to accept your PRs or to request for a change.

Each commit message consists of a header, a body and a footer.

<header>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The header contains a succinct description of the change:

  • use the imperative, present tense: “change” not “changed” nor “changes”
  • don’t capitalize first letter
  • no dot (.) at the end

Body

If your change is simple, the body is optional. Just as in the header, use the imperative, present tense: “change” not “changed” nor “changes”. The body should include the motivation for the change and contrast this with previous behavior.

The footer is the place to reference GitHub issues that this commit Closes.

You must use the GitHub keywords for automatically closing the issues referenced in your commit.

Example

For example, here is a good commit message:

upgrade to Python 3.6.1

upgrade the project builds to use the new Python 3.6.1,
see https://www.python.org/download/releases/

Fix #1234

Developer Portal

If you would like to contribute by helping us improve, expand, or otherwise enhance the SingularityNET Developer Portal you are welcome to do so. You can send a PR for simple changes, or first open an issue for big changes here. To find an overview of how this developer portal works, please click here.