1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
.. _contributing:
Contributing
============
Contributions to ``tiered_debug`` are welcome! This guide outlines how to contribute to the project.
Getting Started
---------------
1. **Fork the repository** (if hosted on a platform like GitHub).
2. **Clone your fork**:
.. code-block:: bash
git clone https://github.com/your-username/tiered_debug.git
cd tiered_debug
3. **Install dependencies**:
.. code-block:: bash
pip install pytest
4. **Run tests** to ensure the project is working:
.. code-block:: bash
pytest test_base.py -v
Submitting Changes
------------------
1. **Create a branch** for your changes:
.. code-block:: bash
git checkout -b my-feature
2. **Make changes** and commit with clear messages:
.. code-block:: bash
git commit -m "Add feature X to TieredDebug"
3. **Update tests** in ``test_base.py`` to cover your changes.
4. **Run tests** to verify:
.. code-block:: bash
pytest
5. **Push to your fork** and create a pull request:
.. code-block:: bash
git push origin my-feature
Code Style
----------
- Follow PEP 8 for Python code style.
- Use Sphinx autodoc docstrings (reStructuredText) for documentation.
- Ensure all public methods and classes are documented.
Documentation
-------------
Update documentation in the ``docs`` folder when adding features:
- Edit RST files (``usage.rst``, ``api.rst``, etc.).
- Add entries to ``CHANGELOG.rst`` under the appropriate version.
Run Sphinx to build docs locally:
.. code-block:: bash
cd docs
pip install sphinx
make html
Open ``docs/_build/html/index.html`` to view the generated documentation.
Issues and Feedback
-------------------
Report bugs or suggest features by opening an issue on the project's repository
(if applicable) or contacting the maintainer directly.
|
