Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Contributing Guidelines For Skorch #1087

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
.. image:: https://github.com/skorch-dev/skorch/blob/master/assets/skorch_bordered.svg
:width: 30%

===========================
How to Contribute to Skorch
===========================

We ❤️ contributions from the open-source community! We follow the Contributor Convenant Code of Conduct that ensures a positive
ParagEkbote marked this conversation as resolved.
Show resolved Hide resolved
experience for contributors and maintainers. To know more, please see `here <https://www.contributor-covenant.org/version/2/1/code_of_conduct/>`


To begin contributing, you need to clone the repository from source and install dev dependencies as shown below:
ParagEkbote marked this conversation as resolved.
Show resolved Hide resolved


conda installation
==================

.. code:: bash

git clone https://github.com/skorch-dev/skorch.git
cd skorch
# create and activate a virtual environment
python -m pip install -r requirements.txt
# install pytorch version for your system (see below)
python -m pip install -r requirements-dev.txt
python -m pip install -e .

py.test # unit tests
pylint skorch # static code checks

pip installation
================

.. code:: bash

git clone https://github.com/skorch-dev/skorch.git
cd skorch
conda create -n skorch-env python=3.10
conda activate skorch-env
conda install -c pytorch pytorch
python -m pip install -r requirements.txt
python -m pip install -r requirements-dev.txt
python -m pip install -e .

py.test # unit tests
pylint skorch # static code checks

It is recommend to run the unit tests and static code checks before submitting a PR
to ensure the predefined coding standards are followed.

===========
ParagEkbote marked this conversation as resolved.
Show resolved Hide resolved
Maintainers
===========

You can tag the following maintainers to request a review for your PR:

29 changes: 0 additions & 29 deletions README.rst
ParagEkbote marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -183,21 +183,6 @@ To install skorch from source using conda, proceed as follows:
python -m pip install -r requirements.txt
python -m pip install .

If you want to help developing, run:

.. code:: bash

git clone https://github.com/skorch-dev/skorch.git
cd skorch
conda create -n skorch-env python=3.10
conda activate skorch-env
conda install -c pytorch pytorch
python -m pip install -r requirements.txt
python -m pip install -r requirements-dev.txt
python -m pip install -e .

py.test # unit tests
pylint skorch # static code checks

You may adjust the Python version to any of the supported Python versions.

Expand All @@ -215,20 +200,6 @@ For pip, follow these instructions instead:
# install pytorch version for your system (see below)
python -m pip install .

If you want to help developing, run:

.. code:: bash

git clone https://github.com/skorch-dev/skorch.git
cd skorch
# create and activate a virtual environment
python -m pip install -r requirements.txt
# install pytorch version for your system (see below)
python -m pip install -r requirements-dev.txt
python -m pip install -e .

py.test # unit tests
pylint skorch # static code checks

PyTorch
=======
Expand Down
Loading