Commit Graph

39 Commits

Author SHA1 Message Date
Kaushik B 9b99328d44
Update Contributing Guide (#6118)
* Update Contributing Guide

* update docs
2021-02-22 07:21:01 +00:00
Eric Cousineau 4f63942c4d
Makefile: Refer to CONTRIBUTING doc, reword `test` to avoid "example" (#5910)
CONTRIBUTING: Add concrete example for running single test
2021-02-15 19:05:49 +00:00
Eric Cousineau ae19c9723b
tests: Remove usage of --flake8 flag (#5909)
* tests: Remove usage of --flake8 flag

* Remove commented line

Co-authored-by: Carlos Mocholi <carlossmocholi@gmail.com>
2021-02-12 12:25:08 -05:00
Jirka Borovec 0038095427 add make for docs (#5685)
* add make docs

* docs
2021-02-05 21:40:40 +01:00
Jirka Borovec e45fde51b6 add contrib questions (#5691)
* add contrib questions

* Apply suggestions from code review

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Apply suggestions from code review

Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
Co-authored-by: Roger Shieh <sh.rog@protonmail.ch>

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: ananthsub <ananth.subramaniam@gmail.com>
Co-authored-by: Roger Shieh <sh.rog@protonmail.ch>
2021-02-05 21:40:40 +01:00
Carlos Mocholí aa03b73e60
Remove psf/black references (#5739)
* Update pyproject.toml

* Update setup.cfg

* Update test.txt

* Update CONTRIBUTING.md

* Update requirements/test.txt
2021-02-03 08:37:06 +00:00
Jirka Borovec bddc6cd77a
pytest default color (#4703)
* pytest default color

* time

Co-authored-by: chaton <thomas@grid.ai>
2020-11-18 10:53:44 +00:00
chaton 35f00df176
[FEAT] Add pytest section to Contribution how to ? (#4633)
* update contributing

* formatting
2020-11-12 11:48:54 +00:00
Jeff Yang 79fc92647c
[make] Create Makefile (#4620)
* [make] Create Makefile

* exclude makefile

* contributing info

* rm .run_local_test.sh
2020-11-12 09:25:31 +00:00
Marc Ferradou bff99ee159
Small typo correction on CONTRIBUTING.md (#4625)
* Update CONTRIBUTING.md

Small typo correction.

* Update .github/CONTRIBUTING.md

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Co-authored-by: Roger Shieh <sh.rog@protonmail.ch>
2020-11-12 08:59:33 +01:00
chaton 829d90b257
activated color in all pytest runs (#4254)
* activated color in all pytest runs

* Update .drone.yml

Co-authored-by: Jeff Yang <ydcjeff@outlook.com>

Co-authored-by: Jeff Yang <ydcjeff@outlook.com>
2020-10-20 16:38:17 +02:00
Jirka Borovec d3567c33a6
move base req. to root (#4219)
* move base req. to root

* check-manifest

* check-manifest

* manifest

* req
2020-10-18 20:40:18 +02:00
Jeff Yang 951048a81e
docs: use ref for anchor links, fix a few typo (#3486) 2020-09-13 21:04:21 -04:00
Nathan Raw 118bd14d16
Update CONTRIBUTING.md (#2927)
* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Apply suggestions from code review

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
2020-08-12 12:59:36 +02:00
Jirka Borovec aa6fe25436
Fix install setup - push pypi (#2872)
* fix setup install

* fix setup install

* 📝 edit docs install command

Co-authored-by: nateraw <nxr9266@g.rit.edu>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2020-08-07 19:02:38 -04:00
Rosario Scalise b37c35a8ff
Update CONTRIBUTING.md (#2855)
* Update CONTRIBUTING.md

Added docker option to testing section.

* Apply suggestions from code review

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
2020-08-07 11:53:29 +02:00
Jeff Yang 4307dd9dc6
fix PR link (#2858) 2020-08-07 09:43:38 +02:00
edenlightning 1dc411fc53
Update contributing guide (#2830)
* update contributing.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Apply suggestions from code review

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>

* Update .github/CONTRIBUTING.md

* suggestion from code review

* minor changes

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
2020-08-06 22:46:45 +02:00
Nathan Raw 9ab071588b
Setup extras (#2831)
* 🎨 use package extras

* 🎨 get extras from reqs

* 🎨 .

* 📝 docs

* 🎨 .
2020-08-06 07:12:47 -04:00
Llannelongue fa2233f56f
Corrected typo `python -m pip pre-commit install` (#2447) 2020-07-01 07:02:02 -04:00
Jirka Borovec 206245ef69
Docs & Changelog (#2176)
* missed

* format

* math

* req

* notes

* fix CI

* Apply suggestions from code review

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2020-06-13 19:29:21 -04:00
Jirka Borovec bfaabd7b7f
clean requirements (#2128)
* clean requirements

* missing

* missing

* req

* min

* default >> base

* base.txt
2020-06-13 10:15:22 -04:00
Charles 9045b6c599
Fix typo in contributing docs (#2076) 2020-06-12 13:11:08 +02:00
Udit Arora a1658ea63d
Add docs about example dependencies (#2122)
* Add torchvision and gym dependencies

* Add pl_examples/requirements.txt to the list of dependencies for running local tests
2020-06-09 07:09:03 -04:00
kumuji fd7814d287
Added black formater for the code with code-checker on pull (#1610)
* black

Added throught black.toml other options are hard so far

No caching for black github action

Moved from black.toml to pyproject.toml

Exclude not only yml but also yaml

Update pyproject.toml

Co-authored-by: Thomas Johansen <thomasjo@gmail.com>

Update .github/workflows/code-formatting-check.yml

mergify

Remove formating check

E231 error ignoring because of black formating

Updated CONTRIBUTING to the master

* Update .github/workflows/code-formatting-check.yml

* Bump black to 19.10b0 version

* resolved incorrect merge of CONTRIBUTING,

Black skipping string normalization

* Minor fixes in CONTRIBUTING, two typos

* Update setup.cfg

* chlog

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Jirka <jirka@pytorchlightning.ai>
2020-06-03 18:23:14 +02:00
Jirka Borovec 69575204f2
notes on Bug fixing (#2053)
* import

* Apply suggestions from code review

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2020-06-02 18:47:03 -04:00
edenafek fdbbe96825
docs/fix_CONTRIBUTING.md (#1984)
* Update CONTRIBUTING.md

typos

* Apply suggestions from code review

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
2020-05-29 23:05:43 -04:00
Jirka Borovec 8ee6d91d0e
code guideline (#1949)
* code rule

* Apply suggestions from code review

Co-authored-by: Jeremy Jordan <13970565+jeremyjordan@users.noreply.github.com>

* chlog

Co-authored-by: Jeremy Jordan <13970565+jeremyjordan@users.noreply.github.com>
Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
2020-05-28 14:40:49 +00:00
Jirka Borovec 0b22b64a10
Tests/docker (#1573)
* devel image

* try parallel

* new image
2020-04-23 12:52:59 -04:00
Adrian Wälchli 7131685ae3
CI: Docs build preview in each PR (#1494)
* store html artifacts in circle ci

* add note to contributing.md
2020-04-19 17:07:16 -04:00
Jirka Borovec 1ee2837d62
add QA to docs (#1374)
* add QA to docs

* not about doc updates by @awaelchli

* Apply suggestions from code review

Co-Authored-By: Adrian Wälchli <adrian.waelchli@students.unibe.ch>

* help

Co-authored-by: Adrian Wälchli <adrian.waelchli@students.unibe.ch>
2020-04-17 18:17:33 -04:00
Jirka Borovec 25bb33ad45
extend docs notes (#1004)
* wip

* notes

* WIP

* example

* notes
2020-03-06 07:07:04 -05:00
Jirka Borovec b2d8f26e46
update PR guidelines (#993)
* update PR guidelines

* update tests

* add CircleCI

* Update CONTRIBUTING.md

Co-authored-by: William Falcon <waf2107@columbia.edu>
2020-03-01 22:15:37 -05:00
Jirka Borovec 9f939447f2
add autopep8 to Contributions guide (#852)
* add autopep8 to Contrib.

* simplify cmd

* update GH templates

* add pytest-flake8

* update GH template
2020-02-15 20:24:38 -05:00
William Falcon f9a3e03e1c
Update CONTRIBUTING.md 2019-11-05 10:49:22 -05:00
Ir1dXD 9a5307dc30 add coding styleguide (#460)
* Update CONTRIBUTING.md

add coding styleguide

* Update CONTRIBUTING.md
2019-11-05 08:29:24 -05:00
William Falcon 28c3bcb0c0
Update CONTRIBUTING.md 2019-10-24 06:26:39 -04:00
William Falcon 48eabf0751
Update CONTRIBUTING.md 2019-10-24 06:25:56 -04:00
Jirka Borovec cd89b4ef43 move GH docs (#168) 2019-08-27 07:10:26 -04:00