Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
Thank you for your contribution to the OpenRAG project! 🚀
Comment thread
aimurphy marked this conversation as resolved.

## Contribution guidelines

To improve the chances of your PR being accepted, review the following guidelines _before_ submitting a PR:

- Follow the project structure, style, and dev/test guidelines described in [CONTRIBUTING.md](https://github.com/langflow-ai/openrag/blob/main/CONTRIBUTING.md#create-a-pull-request).
- Keep PRs small and focused on a single change or set of related changes. PRs that are too large for the maintainers to review effectively can be rejected outright.
- [Add or update documentation](https://docs.openr.ag/support/contribute/#contribute-documentation), if needed.
- Monitor your PR after you submit it, and respond to comments in a timely manner. Inactive PRs can be closed at the maintainers' discretion.

## Description

<!-- Summarize your changes. Explain what you changed _and_ why. -->

<!-- In this PR, I changed/added/removed .... -->
<!-- This change is beneficial because .... -->

## Related issues

The following [issues](https://github.com/langflow-ai/openrag/issues) are related to this PR:

<!-- Fixes #... -->
<!-- Closes #... -->

## Type of changes

Select all that apply:

- [ ] `build`: Changes to the build system or build tooling
- [ ] `chore`: Chore or trivial change
- [ ] `ci`: Changes to CI/CD pipelines or GitHub Actions
- [ ] `docs`: Documentation update
- [ ] `feat`: New feature or enhancement
- [ ] `fix`: Bug fix
- [ ] `perf`: Performance improvements
- [ ] `refactor`: Rewrite existing code
- [ ] `revert`: Revert a previously merged change
- [ ] `style`: UX/UI changes
- [ ] `test`: Changes to tests or test coverage

💡The first word in your PR title must match one of the change categories to pass the PR title check.

## Breaking changes

Does this PR introduce breaking changes?

- [ ] Yes
- [ ] No
- [ ] Not sure

## Tests

Select the tests you ran to verify your changes:

- [ ] Unit tests
- [ ] Manual testing (please explain)
- [ ] Not applicable (ex. documentation changes)
- [ ] Other (please explain)

Explanation of tests (if needed):

<!-- To test the changes in this PR, I .... -->
<!-- I tested my changes in the following environments/OS/architectures: ... -->

## Disclosure of AI-generated code

This section is optional, but it can help set the context for your PR.

Please let us know if your PR contains AI-generated code:

- [ ] More than 50% of this PR is AI-generated code (please explain)
- [ ] Less than 50% of this PR is AI-generated code (please explain)
- [ ] I didn't use AI tools for this PR, or I used trivial assistance like spell check or small in-line suggestions

If your PR contains AI-generated code, please answer the following questions:

- Where is the AI-generated code in your PR? Which files, functions, or lines?
- Answer:
- Did you edit the code after generating it? For example, did you make the code more secure, remove redundancies, or add exception handling?
- Answer:
- What is your level of proficiency in the code's language (none, beginner, intermediate, advanced, expert)?
- Answer:

## (Optional) Other information

<!-- Screenshots or other details relevant to your PR, if needed. -->
Loading