Skip to content

Latest commit

 

History

History
32 lines (17 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

32 lines (17 loc) · 2.3 KB

Contributing Guidelines for Promptfile

Do you welcome first-time open source contributors?

Absolutely we do.

Here is a guide we have found helpful when thinking about how to make Promptfile easy to contribute to. The project is early, but we think it has the potential to help welcome in even more people into playing, building, and shipping LLMs.

What contributions are accepted?

We welcome all types of contributions including bug reports, feature requests, documentation fixes, code improvements, example Promptfile files and even entire features.

Contributing Documentation Fixes/Suggestions

If you want to make an adjustment to documentation with a quick fix, feel free to clone the repository and make some changes in a working branch and then commit those changes. Once you have finished all your changes, create a pull request.

Once the pull request is made, a Promptfile main contributor will review the PR and work with you on getting the PR merged. Quick documentation changes should be merged pretty quickly.

Contributing Bug Reports/Feature Requests

Open a detailed issue report here. Follow the issue templates to help provide the most amount of context to get help. There are two different types of issues:

  • Bug Reports: Please open a Community Bug Report. Follow the issue template and provide as much context as you can
  • Feature Requests: Please open a Community Feature Request to suggest a new feature. It's helpful if you can provide details on the problem you're trying to solve and how the proposed feature would work. This allows us to have a discussion to determine if the feature is a good fit for the project. Although the project is extremely early, we hope to keep the community up to date with the prioritization and feature roadmap.

Contributing Code

If you want to make a code fix, feel free to clone the repository and make some changes in a working branch and then commit those changes. Once you have finished all your changes, create a pull request.

Our current CI pipline should help run some checks and tests and we are actively working on improving CI/CD.

Once the pull request is made, a Promptfile main contributor will review the PR and work with you on getting the PR merged.