You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.rst
+13-7Lines changed: 13 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
-
Thank you for considering contributing to ``pymc-learn``! This project is intended to be a space where anyone can share models they've built.
2
-
3
-
Please read these guidelines before submitting anything to the project. As of the first release, I'm the only person working on this project so respecting these guidelines will help me get back to you more quickly.
1
+
Thank you for considering contributing to ``pymc-learn``! Please read these
2
+
guidelines before submitting anything to the project.
4
3
5
4
Some ways to contribute:
6
5
@@ -62,7 +61,7 @@ in case there have been any changes:
62
61
git fetch upstream
63
62
git rebase upstream/master
64
63
65
-
Then push the changes to your Gitlab account with:
64
+
Then push the changes to your Github account with:
66
65
67
66
.. code-block:: bash
68
67
@@ -75,8 +74,8 @@ Pull Request Checklist
75
74
................................
76
75
77
76
- Ensure your code has followed the Style Guidelines below
78
-
- Make sure you have written unittests where appropriate
79
-
- Make sure the unittests pass
77
+
- Make sure you have written tests where appropriate
78
+
- Make sure the tests pass
80
79
81
80
.. code-block:: bash
82
81
@@ -104,11 +103,18 @@ For the most part, this library follows PEP8 with a couple of exceptions.
104
103
Notes:
105
104
106
105
- Indent with 4 spaces
107
-
- Lines should be a maximum of 80 characters long
106
+
- Lines can be 80 characters long
108
107
- Docstrings should be written as numpy docstrings
109
108
- Your code should be Python 3 compatible
110
109
- When in doubt, follow the style of the existing code
111
110
111
+
Contact
112
+
.............
113
+
114
+
To report an issue with ``pymc-learn`` please use the `issue tracker <https://github.com/pymc-learn/pymc-learn/issues>`__.
115
+
116
+
Finally, if you need to get in touch for information about the project, `send us an e-mail <devs@pymc-learn.org>`__.
Copy file name to clipboardExpand all lines: docs/develop.rst
+7-8Lines changed: 7 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,8 @@
1
1
Contributing
2
2
=============
3
3
4
-
Thank you for considering contributing to ``pymc-learn``! This project is intended to be a space where anyone can share models they've built.
5
-
6
-
Please read these guidelines before submitting anything to the project. As of the first release, I'm the only person working on this project so respecting these guidelines will help me get back to you more quickly.
4
+
Thank you for considering contributing to ``pymc-learn``! Please read these
5
+
guidelines before submitting anything to the project.
7
6
8
7
Some ways to contribute:
9
8
@@ -65,7 +64,7 @@ in case there have been any changes:
65
64
git fetch upstream
66
65
git rebase upstream/master
67
66
68
-
Then push the changes to your Gitlab account with:
67
+
Then push the changes to your Github account with:
69
68
70
69
.. code-block:: bash
71
70
@@ -78,13 +77,13 @@ Pull Request Checklist
78
77
................................
79
78
80
79
- Ensure your code has followed the Style Guidelines below
81
-
- Make sure you have written unittests where appropriate
82
-
- Make sure the unittests pass
80
+
- Make sure you have written tests where appropriate
81
+
- Make sure the tests pass
83
82
84
83
.. code-block:: bash
85
84
86
85
conda activate myenv
87
-
python -m unittest discover -cv
86
+
python -m pytest
88
87
89
88
NOTE: On Windows, in your Anaconda Prompt, run ``activate myenv``.
90
89
@@ -107,7 +106,7 @@ For the most part, this library follows PEP8 with a couple of exceptions.
107
106
Notes:
108
107
109
108
- Indent with 4 spaces
110
-
- Lines can be 120 characters long
109
+
- Lines can be 80 characters long
111
110
- Docstrings should be written as numpy docstrings
112
111
- Your code should be Python 3 compatible
113
112
- When in doubt, follow the style of the existing code
0 commit comments