Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

69 lines (44 loc) · 1.88 KB

Contributing to nimba-python

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

Got an API/Product Question or Problem?

If you have questions about how to use nimbasms-python, please see our docs, and if you don't find the answer there, please contact help@nimbasms.com with any issues you have.

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][issue-link].

Want a Feature?

You can request a new feature by submitting an issue to our [GitHub Repository][github].

Submission Guidelines

Before you submit your pull request consider the following guidelines:

  • Fork project in Github

  • Clone project in your personal repository

     git clone git@github.com:your-user-name/nimbasms-python.git

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch main

  • Commit your changes using a descriptive commit message:

    git add .
git commit -m "Message descriptive"

  • Push your branch to GitHub:

    git push origin my-fix-branch

In GitHub, send a pull request to nimbasms-python:main. If we suggest changes, then:

  • Make the required updates.
  • Re-run the python-python test suite to ensure tests are still passing.
  • Commit your changes to your branch (e.g. my-fix-branch).
  • Push the changes to your GitHub repository (this will update your Pull Request).

That's it! Thank you for your contribution!