Skip to content

Commit

Permalink
added landing page for contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
vicpaton committed Jan 15, 2025
1 parent 911f9d7 commit 1972640
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ NetworkCommons: Table of Contents
:maxdepth: 2
:caption: Contribution guidelines

guidelines/landing
guidelines/guide_1_data
guidelines/guide_2_methods
guidelines/guide_3_eval
Expand Down
34 changes: 34 additions & 0 deletions docs/src/guidelines/landing.rst
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!

0 comments on commit 1972640

Please sign in to comment.