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
docs: align documentation with code and adopt LF-style conventions
- Rewrite README, CONTRIBUTING, CODE_OF_CONDUCT, GOVERNANCE, RELEASE
to follow Linux Foundation documentation conventions
- Fix all stale botanu_use_case references to botanu_workflow across docs
- Correct event/run/outcome terminology throughout
- Remove botanu_outcome from public API exports (keep emit_outcome only)
- Fix enable(), BotanuConfig, RunContext signatures to match implementation
- Update all code examples to use abstract patterns (do_work, etc.)
- Align span attributes, defaults, and env vars with actual code
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
In the interest of fostering an open and welcoming environment, we as contributors and maintainers agree to abide by the Code of Conduct available at https://lfprojects.org/policies/code-of-conduct/
3
+
All participants in the Botanu project — including contributors, maintainers,
4
+
and community members — are expected to treat each other with respect and
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+42-13Lines changed: 42 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,28 @@
1
1
# Contributing to Botanu SDK
2
2
3
-
Thank you for your interest in contributing to Botanu SDK! This document provides guidelines and instructions for contributing.
3
+
We welcome contributions of all kinds — bug fixes, new features, documentation
4
+
improvements, and more. This guide explains how to get started.
4
5
5
6
## Developer Certificate of Origin (DCO)
6
7
7
-
This project requires all commits to be signed off in accordance with the [Developer Certificate of Origin (DCO)](https://developercertificate.org/). This certifies that you have the right to submit your contribution under the project's open source license.
8
+
This project requires all commits to be signed off in accordance with the
9
+
[Developer Certificate of Origin (DCO)](https://developercertificate.org/).
10
+
The DCO certifies that you have the right to submit your contribution under the
11
+
project's open-source license.
8
12
9
-
To sign off your commits, add the `-s` flag to your git commit command:
13
+
To sign off your commits, add the `-s` flag:
10
14
11
15
```bash
12
16
git commit -s -m "Your commit message"
13
17
```
14
18
15
-
This will add a `Signed-off-by` line to your commit message:
19
+
This adds a `Signed-off-by` line to your commit message:
16
20
17
21
```
18
22
Signed-off-by: Your Name <your.email@example.com>
19
23
```
20
24
21
-
If you've already made commits without signing off, you can amend them:
25
+
If you have already made commits without signing off, you can amend them:
22
26
23
27
```bash
24
28
# Amend the last commit
@@ -43,12 +47,17 @@ git rebase --signoff HEAD~N # where N is the number of commits
43
47
pip install -e ".[dev]"
44
48
```
45
49
46
-
3. Run tests:
50
+
3. Install pre-commit hooks:
51
+
```bash
52
+
pre-commit install
53
+
```
54
+
55
+
4. Run tests:
47
56
```bash
48
57
pytest tests/
49
58
```
50
59
51
-
4. Run linting and type checks:
60
+
5. Run linting and type checks:
52
61
```bash
53
62
ruff check src/ tests/
54
63
ruff format src/ tests/
@@ -57,11 +66,26 @@ git rebase --signoff HEAD~N # where N is the number of commits
57
66
58
67
## Pull Request Process
59
68
60
-
1. Fork the repository and create a feature branch
69
+
1. Fork the repository and create a feature branch from `main`
61
70
2. Make your changes with appropriate tests
62
71
3. Ensure all tests pass and linting is clean
63
72
4. Sign off all commits with DCO
64
-
5. Submit a pull request with a clear description
73
+
5. Submit a pull request with a clear description of the change
74
+
75
+
Pull requests require approval from at least one [maintainer](./MAINTAINERS.md)
76
+
before merging.
77
+
78
+
## Finding Work
79
+
80
+
- Look for issues labelled
81
+
[`good first issue`](https://github.com/botanu-ai/botanu-sdk-python/labels/good%20first%20issue)
0 commit comments