Skip to content

Commit 70eb566

Browse files
committed
Update AUTHORS and CONTRIBUTING guidelines
1 parent 7dfd6c9 commit 70eb566

File tree

2 files changed

+44
-57
lines changed

2 files changed

+44
-57
lines changed

AUTHORS.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Credits
22

3-
43
## Development Lead
54

65
* Manfred Dennerlein Rodelo <[email protected]>
76

87
## Contributors
98

10-
None yet. Why not be the first?
9+
* [cdce8p](https://github.com/cdce8p)

CONTRIBUTING.md

+43-55
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Contributing
22

3-
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.
54

65
You can contribute in many ways:
76

@@ -13,118 +12,107 @@ Report bugs at <https://github.com/tr4nt0r/pyloadapi/issues>.
1312

1413
If you are reporting a bug, please include:
1514

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.
2018

2119
### Fix Bugs
2220

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.
2522

2623
### Implement Features
2724

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.
3126

3227
### Write Documentation
3328

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.
3730

3831
### Submit Feedback
3932

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>.
4234

4335
If you are proposing a feature:
4436

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 :)
5040

5141
## Get Started!
5242

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.
5544

56-
1. Fork the `PyLoadAPI` repo on GitHub.
45+
1. Fork the `PyLoadAPI` repo on GitHub.
5746

58-
2. Clone your fork locally:
47+
2. Clone your fork locally:
5948

60-
``` shell
49+
```shell
6150
$ git clone [email protected]:tr4nt0r/pyloadapi.git
6251
```
6352

64-
3. Install your local copy into a virtualenv. Assuming you have
65-
virtualenvwrapper installed, this is how you set up your fork for
66-
local development:
53+
3. Install your local copy using Hatch. Assuming you have Hatch installed, this is how you set up your fork for local development:
6754

68-
``` shell
69-
$ mkvirtualenv PyLoadAPI
70-
$ cd PyLoadAPI/
71-
$ python setup.py develop
55+
```shell
56+
$ cd pyloadapi
57+
$ hatch env create
58+
$ hatch shell
7259
```
7360

74-
4. Create a branch for local development:
61+
4. Create a branch for local development:
7562

76-
``` shell
63+
```shell
7764
$ git checkout -b name-of-your-bugfix-or-feature
7865
```
7966

8067
Now you can make your changes locally.
8168

82-
5. When you're done making changes, check that your changes pass the
83-
tests:
69+
5. When you're done making changes, check that your changes pass the tests and linting:
8470
85-
``` shell
86-
$ pytest tests
71+
```shell
72+
$ hatch run lint
73+
$ hatch run test
8774
```
8875
89-
6. Commit your changes and push your branch to GitHub:
76+
6. Commit your changes and push your branch to GitHub:
9077
9178
``` shell
9279
$ git add .
9380
$ git commit -m "Your detailed description of your changes."
9481
$ git push origin name-of-your-bugfix-or-feature
9582
```
9683
97-
7. Submit a pull request through the GitHub website.
84+
7. Submit a pull request through the GitHub website.
9885
9986
## Pull Request Guidelines
10087
10188
Before you submit a pull request, check that it meets these guidelines:
10289
103-
1. The pull request should include tests.
104-
2. If the pull request adds functionality, the docs should be updated.
105-
Put your new functionality into a function with a docstring, and add
106-
the feature to the list in README.rst.
107-
3. The pull request should work for Python 3.11 and 3.12. Check
108-
<https://github.com/tr4nt0r/pyloadapi/actions/workflows/pytest.yaml>
109-
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.
11093
11194
## Tips
11295
96+
To run tests across all supported Python versions:
97+
98+
```shell
99+
$ hatch run test --all
100+
```
101+
113102
To run a subset of tests:
114103
115-
``` shell
116-
$ pytest tests/test_api::test_login
104+
```shell
105+
$ hatch run test -- tests/test_api.py::test_login
117106
```
118107
119108
## Deploying
120109
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:
123111

124-
``` shell
125-
$ bump2version patch # possible: major / minor / patch
112+
```shell
113+
$ hatch version patch # options: major / minor / patch
126114
$ git push
127115
$ git push --tags
128116
```
129117

130-
Github Actions will then deploy to PyPI if tests pass.
118+
GitHub Actions will handle the deployment to PyPI if the 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

Comments
 (0)