|
1 | | -Contributing |
2 | | -============ |
| 1 | +# Contributing |
3 | 2 |
|
4 | 3 | Contributions are welcome, and they are greatly appreciated! Every |
5 | 4 | little bit helps, and credit will always be given. |
6 | 5 |
|
7 | | -Types of Contributions |
8 | | ----------------------- |
| 6 | +## Types of Contributions |
9 | 7 |
|
10 | | -Report Bugs |
11 | | -~~~~~~~~~~~ |
| 8 | +### Report Bugs |
12 | 9 |
|
13 | | -Report bugs at https://github.com/rero/rero-invenio-thumbnails/issues. |
| 10 | +Report bugs at <https://github.com/rero/rero-invenio-thumbnails/issues>. |
14 | 11 |
|
15 | 12 | If you are reporting a bug, please include: |
16 | 13 |
|
17 | | -* Your operating system name and version. |
18 | | -* Any details about your local setup that might be helpful in troubleshooting. |
19 | | -* Detailed steps to reproduce the bug. |
| 14 | +- Your operating system name and version. |
| 15 | +- Any details about your local setup that might be helpful in troubleshooting. |
| 16 | +- Detailed steps to reproduce the bug. |
20 | 17 |
|
21 | | -Fix Bugs |
22 | | -~~~~~~~~ |
| 18 | +### Fix Bugs |
23 | 19 |
|
24 | 20 | Look through the GitHub issues for bugs. Anything tagged with "bug" |
25 | 21 | is open to whoever wants to implement it. |
26 | 22 |
|
27 | | -Implement Features |
28 | | -~~~~~~~~~~~~~~~~~~ |
| 23 | +### Implement Features |
29 | 24 |
|
30 | 25 | Look through the GitHub issues for features. Anything tagged with "feature" |
31 | 26 | is open to whoever wants to implement it. |
32 | 27 |
|
33 | | -Write Documentation |
34 | | -~~~~~~~~~~~~~~~~~~~ |
| 28 | +### Write Documentation |
35 | 29 |
|
36 | 30 | rero-invenio-thumbnails could always use more documentation, whether as part of the |
37 | 31 | official rero-invenio-thumbnails docs, in docstrings, or even on the web in blog posts, |
38 | 32 | articles, and such. |
39 | 33 |
|
40 | | -Submit Feedback |
41 | | -~~~~~~~~~~~~~~~ |
| 34 | +### Submit Feedback |
42 | 35 |
|
43 | 36 | The best way to send feedback is to file an issue at |
44 | | -https://github.com/rero/rero-invenio-thumbnails/issues. |
| 37 | +<https://github.com/rero/rero-invenio-thumbnails/issues>. |
45 | 38 |
|
46 | 39 | If you are proposing a feature: |
47 | 40 |
|
48 | | -* Explain in detail how it would work. |
49 | | -* Keep the scope as narrow as possible, to make it easier to implement. |
50 | | -* Remember that this is a volunteer-driven project, and that contributions |
| 41 | +- Explain in detail how it would work. |
| 42 | +- Keep the scope as narrow as possible, to make it easier to implement. |
| 43 | +- Remember that this is a volunteer-driven project, and that contributions |
51 | 44 | are welcome :) |
52 | 45 |
|
53 | | -Get Started! |
54 | | ------------- |
| 46 | +## Get Started! |
55 | 47 |
|
56 | 48 | Ready to contribute? Here's how to set up `rero-invenio-thumbnails` for local development. |
57 | | -The steps use the [`uv`](https://docs.astral.sh/uv/) tool but the equivalent with |
| 49 | +The steps use the [uv](https://docs.astral.sh/uv/) tool but the equivalent with |
58 | 50 | pipenv or other tools is perfectly fine as well. |
59 | 51 |
|
60 | 52 | 1. Fork the `rero/rero-invenio-thumbnails` repo on GitHub. |
61 | 53 | 2. Clone your fork locally: |
62 | 54 |
|
63 | | - .. code-block:: console |
64 | | -
|
65 | | - $ git clone git@github.com:your_name_here/rero-invenio-thumbnails.git |
| 55 | + ```bash |
| 56 | + $ git clone git@github.com:your_name_here/rero-invenio-thumbnails.git |
| 57 | + ``` |
66 | 58 |
|
67 | 59 | 3. Install your local copy into a virtualenv: |
68 | 60 |
|
69 | | - .. code-block:: console |
70 | | -
|
71 | | - $ cd rero-invenio-thumbnails/ |
72 | | - $ uv venv |
73 | | - $ uv pip install -e .[all] |
| 61 | + ```bash |
| 62 | + $ cd rero-invenio-thumbnails/ |
| 63 | + $ uv venv |
| 64 | + $ uv pip install -e .[all] |
| 65 | + ``` |
74 | 66 |
|
75 | 67 | 4. Create a branch for local development: |
76 | 68 |
|
77 | | - .. code-block:: console |
78 | | -
|
79 | | - $ git checkout -b name-of-your-bugfix-or-feature |
| 69 | + ```bash |
| 70 | + $ git checkout -b name-of-your-bugfix-or-feature |
| 71 | + ``` |
80 | 72 |
|
81 | 73 | Now you can make your changes locally. |
82 | 74 |
|
83 | 75 | 5. When you're done making changes, check that your changes pass tests: |
84 | 76 |
|
85 | | - .. code-block:: console |
86 | | -
|
87 | | - $ uv run ./run-tests.sh |
| 77 | + ```bash |
| 78 | + $ uv run poe run_tests |
| 79 | + ``` |
88 | 80 |
|
89 | 81 | The tests will provide you with test coverage and also check PEP8 |
90 | | - (code style), PEP257 (documentation), flake8 as well as build the Sphinx |
91 | | - documentation and run doctests. |
| 82 | + (code style), PEP257 (documentation), flake8 as well as run doctests. |
92 | 83 |
|
93 | 84 | 6. Commit your changes and push your branch to GitHub: |
94 | 85 |
|
95 | | - .. code-block:: console |
96 | | -
|
97 | | - $ git add . |
98 | | - $ git commit -s |
99 | | - -m "component: title without verbs" |
100 | | - -m "* NEW Adds your new feature." |
101 | | - -m "* FIX Fixes an existing issue." |
102 | | - -m "* BETTER Improves and existing feature." |
103 | | - -m "* Changes something that should not be visible in release notes." |
104 | | - $ git push origin name-of-your-bugfix-or-feature |
| 86 | + ```bash |
| 87 | + $ git add . |
| 88 | + $ git commit -s \ |
| 89 | + -m "component: title without verbs" \ |
| 90 | + -m "* NEW Adds your new feature." \ |
| 91 | + -m "* FIX Fixes an existing issue." \ |
| 92 | + -m "* BETTER Improves and existing feature." \ |
| 93 | + -m "* Changes something that should not be visible in release notes." |
| 94 | + $ git push origin name-of-your-bugfix-or-feature |
| 95 | + ``` |
105 | 96 |
|
106 | 97 | 7. Submit a pull request through the GitHub website. |
107 | 98 |
|
108 | | -Pull Request Guidelines |
109 | | ------------------------ |
| 99 | +## Pull Request Guidelines |
110 | 100 |
|
111 | 101 | Before you submit a pull request, check that it meets these guidelines: |
112 | 102 |
|
113 | 103 | 1. The pull request should include tests and must not decrease test coverage. |
114 | 104 | 2. If the pull request adds functionality, the docs should be updated. Put |
115 | 105 | your new functionality into a function with a docstring. |
116 | 106 | 3. The pull request should work for all Python versions currently supported by Invenio. Check |
117 | | - https://github.com/rero/rero-invenio-thumbnails/actions?query=event%3Apull_request |
| 107 | + <https://github.com/rero/rero-invenio-thumbnails/actions?query=event%3Apull_request> |
118 | 108 | and make sure that the tests pass for all supported Python versions. |
0 commit comments