docs: create contributing doc #369
Open
+414
−116
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
moves development and contributing documentation into a standard CONTRIBUTING.md and update current docs to reference it Also includes fixes for incorrect test commands and dir structure Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
Contributor
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
Contributor
Author
|
Note that the ruff and mypy commands documented currently fail. I've opened #370 to address it in a follow up. |
psschwei
reviewed
Jan 27, 2026
| If you are going to contribute to Mellea, it is important that you use our | ||
| pre-commit hooks. Using these hooks -- or running our test suite -- | ||
| requires installing `[all]` optional dependencies and also the dev group. | ||
| For detailed instructions on setting up your development environment, installing dependencies, configuring pre-commit hooks, and running tests, please see our **[Contributing Guide](../CONTRIBUTING.md)**. |
Member
There was a problem hiding this comment.
could we link directly to the dev environment setup section, assuming it exists?
|
|
||
| - Python 3.10 or higher (3.13+ requires [Rust compiler](https://www.rust-lang.org/tools/install) for outlines) | ||
| - [uv](https://docs.astral.sh/uv/getting-started/installation/) (recommended) or conda/mamba | ||
| - [Ollama](https://ollama.com/) (for local testing) |
Member
There was a problem hiding this comment.
Suggested change
| - [Ollama](https://ollama.com/) (for local testing) | |
| - [Ollama](https://ollama.com/download) (for local testing) |
|
|
||
| **Docstrings are prompts** - the LLM reads them, so be specific. | ||
|
|
||
| Use **Google-style docstrings**: |
Member
There was a problem hiding this comment.
Suggested change
| Use **Google-style docstrings**: | |
| Use **[Google-style docstrings](https://google.github.io/styleguide/pyguide.html#381-docstrings)**: |
?
Comment on lines
+174
to
+181
| ### Branch Naming | ||
|
|
||
| Use descriptive branch names with prefixes: | ||
| - `feat/topic` - New features | ||
| - `fix/issue-id` - Bug fixes | ||
| - `docs/topic` - Documentation updates | ||
| - `test/topic` - Test additions/fixes | ||
| - `refactor/topic` - Code refactoring |
Member
There was a problem hiding this comment.
Suggested change
| ### Branch Naming | |
| Use descriptive branch names with prefixes: | |
| - `feat/topic` - New features | |
| - `fix/issue-id` - Bug fixes | |
| - `docs/topic` - Documentation updates | |
| - `test/topic` - Test additions/fixes | |
| - `refactor/topic` - Code refactoring |
Since folks will have to fork the repo, it shouldn't matter what they call the branch.
Comment on lines
+232
to
+242
| ### Pull Request Process | ||
|
|
||
| 1. **Create an issue** describing your change (if not already exists) | ||
| 2. **Fork the repository** (if you haven't already) | ||
| 3. **Create a branch** in your fork using appropriate naming | ||
| 4. **Make your changes** following coding standards | ||
| 5. **Add tests** for new functionality | ||
| 6. **Run the test suite** to ensure everything passes | ||
| 7. **Update documentation** as needed | ||
| 8. **Push to your fork** and create a pull request to the main repository | ||
| 9. **Follow the automated PR workflow** instructions |
Member
There was a problem hiding this comment.
This section is very similar to the contribution pathway 1 above (~L17-L22). Do we need it both places?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Misc PR
Type of PR
Description
Moves development and contributing documentation into a standard
CONTRIBUTING.mddoc and updates current docs to reference it.Also includes fixes for incorrect test commands and dir structure found while creating the doc
Testing