Skip to content

Commit

Permalink
Adds contribution guide, configures issues
Browse files Browse the repository at this point in the history
  • Loading branch information
stumpylog committed Jan 10, 2025
1 parent a7463e0 commit aa0fa75
Show file tree
Hide file tree
Showing 5 changed files with 161 additions and 0 deletions.
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: Bug Report
description: Create a report to help us improve tika-client
title: "[BUG] "
labels: ["bug"]
body:
- type: markdown
attributes:
value: "Please fill out this form to help us address your bug report."

- type: input
id: python-version
attributes:
label: Python Version
placeholder: "e.g., 3.11.0"
validations:
required: true

- type: input
id: client-version
attributes:
label: tika-client Version
placeholder: "e.g., 1.0.0"
validations:
required: true

- type: input
id: server-version
attributes:
label: Gotenberg Server Version
placeholder: "e.g., 7.8.3"
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the bug
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps To Reproduce
description: Minimal code example that demonstrates the issue
render: python
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What you expected to happen
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened
validations:
required: true

- type: textarea
id: logs
attributes:
label: Error Output
description: Error messages, stack traces, or any other relevant information
render: shell
validations:
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: 🤔 Questions and Help
url: https://github.com/stumpylog/tika-client/discussions/categories/q-a
about: This issue tracker is not for support questions. Please refer to our Discussions.
- name: 🚀 Feature Request
url: https://github.com/stumpylog/tika-client/discussions/categories/ideas
about: Remember to search for existing feature requests and "up-vote" any you like
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,8 @@
"**/.pytest_cache": true,
"**/.cache": true,
"**/.coverage*": true
},
"yaml.schemas": {
"https://json.schemastore.org/github-issue-config.json": "file:///u%3A/projects/tika-client/.github/ISSUE_TEMPLATE/config.yml"
}
}
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Allow setting user agent string and provide a default ([#37](https://github.com/stumpylog/tika-client/pull/37))
- Support for async (by [@Goldziher](https://github.com/stumpylog/tika-client/pull/39) in [#39](https://github.com/stumpylog/tika-client/pull/39))

### Documentation

- Added contribution guide

## [0.8.1] - 2024-12-17

### Fixed
Expand Down
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Contributing

This document outlines how to contribute to the tika-client project effectively.

## Questions and Support

For general questions and support, please use our [Q&A Discussions](https://github.com/stumpylog/tika-client/discussions/categories/q-a) forum.

## Feature Requests

We use the [Ideas category in Github Discussions](https://github.com/stumpylog/tika-client/discussions/categories/ideas) for feature requests and project improvements. Please check existing discussions before creating a new one to avoid duplicates.

## Bug Reports

If you've identified a bug:

1. Check existing issues to avoid duplicates
2. Create a new issue using the bug report template
3. Include:
- Python version
- tika-client version
- Gotenberg server version
- Minimal code example demonstrating the bug
- Expected vs actual behavior
- Error messages/stack traces if applicable

## Development Setup

1. Fork and clone the repository
1. Install [`uv`](https://astral.sh/uv/) for independent tool installations
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh # Install uv
```
1. Install [`hatch`](https://github.com/pypa/hatch) and [`pre-commit`](https://github.com/pre-commit/pre-commit)
```bash
uv tool install hatch pre-commit
```
1. Set up pre-commit hooks:
```bash
pre-commit install
```

## Code Style

We use [`hatch`](https://github.com/pypa/hatch) for project management, testing, and formatting:

- Run tests: `hatch test`
- Format & lint code: `hatch fmt`
- Check formatting: `hatch fmt --check`
- Check typing: `hatch run typing:run`

Please ensure all tests pass and code is properly formatted before submitting changes. The code must pass the CI to be merged.

## Pull Request Process

1. Create a new branch from `develop`
2. Make your changes
3. Update tests and documentation
4. Run the test suite
5. Submit a PR against `develop`
6. Reference any related issues

PRs should:

- Focus on a single feature/fix
- Include tests for new functionality
- Update documentation as needed
- Follow existing code style

## License

By contributing, you agree that your contributions will be licensed under the same terms as the project.

0 comments on commit aa0fa75

Please sign in to comment.