-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
################################### | ||
General guidelines for contribution | ||
################################### | ||
|
||
We appreciate your interest in contributing to **NetworkCommons**. This document provides general guidelines on how to contribute with code, including data, methods or benchmarking contributions, as well as bug reports and feature requests. | ||
|
||
-------------------- | ||
General Instructions | ||
-------------------- | ||
|
||
If you would like to contribute to NetworkCommons, please follow these steps: | ||
|
||
1. Fork the NetworkCommons repository on GitHub into your personal/organisation space. | ||
2. Create a new branch for your changes. | ||
3. Make your changes and commit them to your branch. | ||
4. Push your branch to your forked repository. | ||
5. Open a pull request from your branch to the main NetworkCommons repository. | ||
6. Your pull request will be reviewed by the NetworkCommons team, and you may be asked to make changes before it is merged. | ||
|
||
More detailed instructions can be found in the specific contribution guidelines: | ||
|
||
- :doc:`Data <./guide_1_data>` | ||
- :doc:`Methods <./guide_2_methods>` | ||
- :doc:`Evaluation <./guide_3_eval>` | ||
|
||
For examples of pull requests, please have a look at the addition of `Signalling Profiler <https://github.com/saezlab/networkcommons/pull/62>`_ in the methods section, or an `EGF phosphoproteomics <https://github.com/saezlab/networkcommons/pull/61>`_ dataset in the data section. | ||
|
||
-------------------------------- | ||
Bug Reports and Feature Requests | ||
-------------------------------- | ||
|
||
If you encounter a bug while using NetworkCommons, or would like a new feature to be implemented, please open an `issue <https://github.com/saezlab/networkcommons/issues/new>`_ in the NetworkCommons GitHub repository. | ||
|
||
We appreciate your contributions to NetworkCommons and look forward to reviewing your pull requests and feedback! |