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
Contributions are welcome, and they are greatly appreciated! Every
4
-
little bit helps, and credit will always be given.
3
+
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
5
4
6
5
You can contribute in many ways:
7
6
@@ -13,118 +12,107 @@ Report bugs at <https://github.com/tr4nt0r/pyloadapi/issues>.
13
12
14
13
If you are reporting a bug, please include:
15
14
16
-
- Your operating system name and version.
17
-
- Any details about your local setup that might be helpful in
18
-
troubleshooting.
19
-
- Detailed steps to reproduce the bug.
15
+
- Your operating system name and version.
16
+
- Any details about your local setup that might be helpful in troubleshooting.
17
+
- Detailed steps to reproduce the bug.
20
18
21
19
### Fix Bugs
22
20
23
-
Look through the GitHub issues for bugs. Anything tagged with "bug"
24
-
and "help wanted" is open to whoever wants to implement it.
21
+
Look through the GitHub issues for bugs. Anything tagged with "👻 bug" and "🙏🏼 help wanted" is open to whoever wants to implement it.
25
22
26
23
### Implement Features
27
24
28
-
Look through the GitHub issues for features. Anything tagged with
29
-
"enhancement" and "help wanted" is open to whoever wants to
30
-
implement it.
25
+
Look through the GitHub issues for features. Anything tagged with "🚀 feature" and "🙏🏼 help wanted" is open to whoever wants to implement it.
31
26
32
27
### Write Documentation
33
28
34
-
PyLoadAPI could always use more documentation, whether as part of the
35
-
official PyLoadAPI docs, in docstrings, or even on the web in blog
36
-
posts, articles, and such.
29
+
PyLoadAPI could always use more documentation, whether as part of the official PyLoadAPI docs, in docstrings, or even on the web in blog posts, articles, and such.
37
30
38
31
### Submit Feedback
39
32
40
-
The best way to send feedback is to file an issue at
41
-
<https://github.com/tr4nt0r/pyloadapi/issues>.
33
+
The best way to send feedback is to file an issue at <https://github.com/tr4nt0r/pyloadapi/issues>.
42
34
43
35
If you are proposing a feature:
44
36
45
-
- Explain in detail how it would work.
46
-
- Keep the scope as narrow as possible, to make it easier to
47
-
implement.
48
-
- Remember that this is a volunteer-driven project, and that
49
-
contributions are welcome :)
37
+
- Explain in detail how it would work.
38
+
- Keep the scope as narrow as possible, to make it easier to implement.
39
+
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
50
40
51
41
## Get Started!
52
42
53
-
Ready to contribute? Here's how to set up `PyLoadAPI` for
54
-
local development.
43
+
Ready to contribute? Here's how to set up `PyLoadAPI` for local development.
and make sure that the tests pass for all supported Python versions.
90
+
1. The pull request should include tests.
91
+
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
92
+
3. The pull request should work for Python 3.10 to 3.13. Check the [build workflow](https://github.com/tr4nt0r/pyloadapi/actions/workflows/build.yml) and make sure that the tests pass for all supported Python versions.
110
93
111
94
## Tips
112
95
96
+
To run tests across all supported Python versions:
97
+
98
+
```shell
99
+
$ hatch run test --all
100
+
```
101
+
113
102
To run a subset of tests:
114
103
115
-
```shell
116
-
$ pytest tests/test_api::test_login
104
+
```shell
105
+
$ hatch run test -- tests/test_api.py::test_login
117
106
```
118
107
119
108
## Deploying
120
109
121
-
A reminder for the maintainers on how to deploy. Make sure all your
122
-
changes are committed (including an entry in CHANGELOG.md). Then run:
110
+
For maintainers, here's a reminder on how to deploy. Ensure all changes are committed, including an entry in`CHANGELOG.md`. Then execute:
123
111
124
-
```shell
125
-
$ bump2version patch # possible: major / minor / patch
112
+
```shell
113
+
$ hatch version patch #options: major / minor / patch
126
114
$ git push
127
115
$ git push --tags
128
116
```
129
117
130
-
Github Actions will then deploy to PyPI if tests pass.
118
+
GitHub Actions will handle the deployment to PyPI ifthe tests pass. A release draft is created by a workflow that tracks all changes and determines the next version (patch, minor, or major) based on the labels assigned to the merged PRs. Review the draft to confirm the version bump.
0 commit comments