Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 2.78 KB
Raw

Contributing to StarPep toolbox

StarPep toolbox is an open source project, and we welcome contributions of different kinds: bug reports, ideas for new features, write and improve the project’s documentation, create use cases showing how the project is applied, help to organize issues, review proposed changes, among other tasks.

Contributor Agreement

By contributing, you agree that we may redistribute your work under our license. In exchange, we will address your issues and/or assess your change proposal as promptly as we can, and help you become a member of our community.

How to Contribute

The easiest way to get started is to file an issue to tell us about a bugs of the software or ideas for new features. This is a good way to introduce yourself and to meet some of our community members.

  1. If you do not have a GitHub account, you can send us comments by email. However, we will be able to respond more quickly if you use one of the other methods described below.

  2. If you have a GitHub account, or are willing to create one, but do not know how to use Git, you can report problems or suggest improvements by creating an issue. This allows us to assign the item to someone and to respond to it in a threaded discussion.

  3. If you are comfortable with Git, and would like to add or change material, you can submit a pull request (PR). Instructions for doing this are included below.

Using GitHub

If you choose to contribute via GitHub, you may want to look at the official guidelines of GitHub. In brief, the GitHub flow is the following:

  1. Create a new branch in your desktop copy of this repository for each significant change.

  2. Commit the change in that branch.

  3. Push that branch to your fork of this repository on GitHub.

  4. Submit a pull request from that branch to the main repository.

  5. If you receive feedback, make changes on your desktop and push to your branch on GitHub: the pull request will update automatically.

Get in touch

If you do not want to use the contributing methods mentioned explained before, you can [reach us by email][[email protected]].

These Contributing Guidelines have been adapted from the Contributing Guidelines of the Software Carpentry (License: CC-BY)