Mirrored-Projects/paperless-gpt
1
0
Fork 0
mirror of https://github.com/icereed/paperless-gpt.git synced 2025-03-12 12:58:02 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

feat: Add CODE_OF_CONDUCT.md and CONTRIBUTING.md files

Browse source
This commit is contained in:
Dominik Schröter 2024-10-20 11:18:17 +02:00
parent 66e0029be5
commit 8b28edb4f7
2 changed files with 327 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

132
CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at <github@icereed.net>.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

195
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,195 @@
# Contributing to paperless-gpt
Thank you for considering contributing to **paperless-gpt**! We welcome contributions of all kinds, including bug reports, feature requests, documentation improvements, and code contributions. By participating in this project, you agree to abide by our [Code of Conduct](#code-of-conduct).
## Table of Contents
- [Contributing to paperless-gpt](#contributing-to-paperless-gpt)
- [Table of Contents](#table-of-contents)
- [Code of Conduct](#code-of-conduct)
- [How Can I Contribute?](#how-can-i-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Submitting Pull Requests](#submitting-pull-requests)
- [Development Setup](#development-setup)
- [Prerequisites](#prerequisites)
- [Backend Setup](#backend-setup)
- [Frontend Setup](#frontend-setup)
- [Coding Guidelines](#coding-guidelines)
- [Style Guidelines](#style-guidelines)
- [Testing](#testing)
- [Documentation](#documentation)
- [Communication](#communication)
- [License](#license)
---
## Code of Conduct
This project and everyone participating in it is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainer.
## How Can I Contribute?
### Reporting Bugs
If you find a bug, please open an issue on GitHub. Before doing so, please check if the issue has already been reported.
- **Use a clear and descriptive title** for the issue.
- **Describe the steps to reproduce the bug**.
- **Include any relevant logs, screenshots, or code snippets**.
- **Provide information about your environment** (OS, Docker version, LLM provider, etc.).
### Suggesting Enhancements
We appreciate new ideas and enhancements.
- **Search existing issues** to see if your idea has already been discussed.
- **Open a new issue** with a descriptive title.
- **Provide a detailed description** of the enhancement and its benefits.
### Submitting Pull Requests
We welcome pull requests (PRs). Please follow these guidelines:
1. **Fork the repository** and create your branch from `main`.
2. **Ensure your code follows** the [Coding Guidelines](#coding-guidelines).
3. **Write clear commit messages** following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
4. **Test your changes** thoroughly.
5. **Update documentation** if necessary.
6. **Submit a pull request** and provide a clear description of your changes.
7. **Link related issues** in your PR description.
## Development Setup
### Prerequisites
- **Go** (version 1.20 or later)
- **Node.js** (version 18 or later)
- **npm** (comes with Node.js)
- **Docker** and **Docker Compose**
### Backend Setup
1. **Clone the repository**:
```bash
git clone https://github.com/icereed/paperless-gpt.git
cd paperless-gpt
```
2. **Set environment variables**:
- Create a `.env` file in the project root.
- Set the required environment variables as per the [README](README.md).
3. **Install Go dependencies**:
```bash
go mod download
```
4. **Run the backend server**:
```bash
go run main.go
```
### Frontend Setup
1. **Navigate to the frontend directory**:
```bash
cd web-app
```
2. **Install Node.js dependencies**:
```bash
npm install
```
3. **Start the frontend development server**:
```bash
npm run dev
```
The application should now be accessible at `http://localhost:8080`.
## Coding Guidelines
- **Languages**: Go for the backend, TypeScript with React for the frontend.
- **Formatting**:
- Use `gofmt` or `goimports` for Go code.
- Use Prettier and ESLint for frontend code (`npm run lint`).
- **Code Structure**:
- Keep code modular and reusable.
- Write clear and concise code with comments where necessary.
- **Dependencies**:
- Manage Go dependencies with `go mod`.
- Manage frontend dependencies with `npm`.
## Style Guidelines
- **Commit Messages**:
- Follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format.
- Examples:
- `feat: add support for custom server-side prompts`
- `fix: resolve API pagination issue for tags`
- Use the imperative mood in the subject line.
- **Branch Naming**:
- Use descriptive names:
- `feat/your-feature-name`
- `fix/issue-number-description`
- `docs/update-readme`
- **Pull Requests**:
- Keep PRs focused; avoid unrelated changes.
- Provide a detailed description of your changes.
- Reference any related issues (`Closes #123`).
## Testing
- **Backend Tests**:
- Write unit tests using Go's `testing` and `github.com/stretchr/testify/assert` packages.
- Run tests with `go test ./...`.
- **Frontend Tests**:
- Use testing libraries like Jest and React Testing Library.
- Run tests with `npm run test`.
- **Continuous Integration**:
- Ensure all tests pass before submitting a PR.
## Documentation
- **Update Documentation**:
- Update the [README](README.md) and other relevant docs for any user-facing changes.
- Include usage examples and configuration instructions.
- **Comment Your Code**:
- Use clear and descriptive comments for complex logic.
- Document exported functions and methods in Go.
## Communication
- **GitHub Issues**: Use for bug reports, feature requests, and questions.
- **Discussions**: Engage in discussions for broader topics.
- **Contact Maintainer**: For sensitive matters, contact the maintainer via email.
## License
By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE).
---
Thank you for your interest in contributing to paperless-gpt! We value your input and look forward to your contributions.