Skip to content

Commit be53ada

Browse files
clstaudtclstaudt
committed
contributing guidelines updated
1 parent 7af31ab commit be53ada

File tree

8 files changed

+160
-167
lines changed

8 files changed

+160
-167
lines changed

‎AUTHORS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Credits
3+
---
4+
5+
# Development Lead
6+
7+
- Christian Staudt \<<[email protected]>\>
8+
9+
# Contributors
10+
11+
None yet. Why not be the first?

‎AUTHORS.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎CONTRIBUTING.md

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
---
2+
title: Contributing
3+
---
4+
5+
Contributions are welcome, and they are greatly appreciated! Every
6+
little bit helps, and credit will always be given.
7+
8+
You can contribute in many ways:
9+
10+
# Types of Contributions
11+
12+
## Report Bugs
13+
14+
Report bugs at <https://github.com/tuttle-dev/tuttle/issues>.
15+
16+
If you are reporting a bug, please include:
17+
18+
- Your operating system name and version.
19+
- Any details about your local setup that might be helpful in
20+
troubleshooting.
21+
- Detailed steps to reproduce the bug.
22+
23+
## Fix Bugs
24+
25+
Look through the GitHub issues for bugs. Anything tagged with \"bug\"
26+
and \"help wanted\" is open to whoever wants to implement it.
27+
28+
## Implement Features
29+
30+
Look through the GitHub issues for features. Anything tagged with
31+
\"enhancement\" and \"help wanted\" is open to whoever wants to
32+
implement it.
33+
34+
## Write Documentation
35+
36+
tuttle could always use more documentation, whether as part of the
37+
official tuttle docs, in docstrings, or even on the web in blog posts,
38+
articles, and such.
39+
40+
## Submit Feedback
41+
42+
The best way to send feedback is to file an issue at
43+
<https://github.com/tuttle-dev/tuttle/issues>.
44+
45+
If you are proposing a feature:
46+
47+
- Explain in detail how it would work.
48+
- Keep the scope as narrow as possible, to make it easier to
49+
implement.
50+
- Remember that this is a volunteer-driven project, and that
51+
contributions are welcome :)
52+
53+
# Get Started!
54+
55+
Ready to contribute? Here\'s how to set up [tuttle]{.title-ref} for
56+
local development.
57+
58+
1. Fork the [tuttle]{.title-ref} repo on GitHub.
59+
60+
2. Clone your fork locally:
61+
62+
``` shell
63+
$ git clone [email protected]:your_name_here/tuttle.git
64+
```
65+
66+
3. Install your local copy into a virtualenv. Assuming you have
67+
virtualenvwrapper installed, this is how you set up your fork for
68+
local development:
69+
70+
``` shell
71+
$ mkvirtualenv tuttle
72+
$ cd tuttle/
73+
$ python setup.py develop
74+
```
75+
76+
4. Create a branch for local development:
77+
78+
``` shell
79+
$ git checkout -b name-of-your-bugfix-or-feature
80+
```
81+
82+
Now you can make your changes locally.
83+
84+
85+
Install the pre-commit hooks before making your first commit to ensure that you match the code style:
86+
87+
``` shell
88+
$ pre-commit install
89+
```
90+
91+
5. When you\'re done making changes, check that your changes pass
92+
code style checks and the tests:
93+
94+
``` shell
95+
$ pytest
96+
```
97+
98+
99+
6. Commit your changes and push your branch to GitHub:
100+
101+
``` shell
102+
$ git add .
103+
$ git commit -m "Your detailed description of your changes."
104+
$ git push origin name-of-your-bugfix-or-feature
105+
```
106+
107+
7. Submit a pull request through the GitHub website.
108+
109+
# Pull Request Guidelines
110+
111+
Before you submit a pull request, check that it meets these guidelines:
112+
113+
1. The pull request should include tests.
114+
2. If the pull request adds functionality, the docs should be updated.
115+
Put your new functionality into a function with a docstring, and add
116+
the feature to the list in README.rst.
117+
3. The pull request should work for Python 3.8, 3.9, 3.10.
118+
119+
# Tips
120+
121+
To run a subset of tests:
122+
123+
``` shell
124+
$ pytest tests.test_tuttle
125+
```
126+
127+
# Deploying
128+
129+
A reminder for the maintainers on how to deploy. Make sure all your
130+
changes are committed (including an entry in HISTORY.rst). Then run:
131+
132+
``` shell
133+
$ bump2version patch # possible: major / minor / patch
134+
$ git push
135+
$ git push --tags
136+
```
137+
138+
Travis will then deploy to PyPI if tests pass.

‎CONTRIBUTING.rst

Lines changed: 0 additions & 128 deletions
This file was deleted.

‎HISTORY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
subtitle: 0.1.0 (2021-10-27)
3+
title: History
4+
---
5+
6+
- First release on PyPI.

‎HISTORY.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎requirements.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ tox==3.14.0
77
coverage==4.5.4
88
Sphinx==1.8.5
99
twine==1.14.0
10-
11-
pytest==6.2.4
12-
10+
pytest
1311
pandas
1412
pandera
1513
altair

‎setup.py

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,16 @@
1010
with open("HISTORY.rst") as history_file:
1111
history = history_file.read()
1212

13-
requirements = [
14-
"pandas",
15-
"pandera",
16-
"altair",
17-
"sqlmodel",
18-
"pyicloud",
19-
"loguru",
20-
"pydantic[email]",
21-
"fints",
22-
"ics",
23-
"babel",
24-
]
13+
with open("requirements.txt") as requirements_file:
14+
requirements = requirements_file.readlines()
15+
2516

2617
dev_requirements = [
2718
"jupyterlab",
2819
"ipywidgets",
2920
]
3021

31-
test_requirements = [
32-
"pytest>=3",
33-
]
22+
test_requirements = []
3423

3524

3625
setup(

0 commit comments

Comments
 (0)