Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (46 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 3.2 KB

Contributing to ItsPrompt

Thank you for your interest in contributing to ItsPrompt. We welcome and appreciate any contributions, whether it is code, documentation, bug reports, feature requests, or general feedback.

How to Contribute

There are many ways you can contribute to this project. Here are some guidelines to help you get started.

If you want to read more about development, please refer to the Development Guide.

Reporting Issues

If you encounter any problems or have any suggestions for improvement, please open an issue on GitHub using the appropriate template. Be as descriptive as possible and include any relevant information such as error messages, screenshots, or steps to reproduce the issue.

If you need help with creating an Issue, join our Discord and don't hesitate to contact us!

Submitting Pull Requests

If you want to contribute code or documentation to this project, you can submit a pull request (PR) on GitHub. Before you do so, please make sure that:

  • You have tested your code locally and ensured that it works as expected (also be sure you have added tests).
  • You have written clear and concise commit messages and PR descriptions.
  • You have updated the documentation if necessary.
  • You have resolved any merge conflicts with the main branch.

If you need help with opening a PR, join our Discord and don't hesitate to contact us!

To submit a PR, follow these steps:

  1. Fork the repository and create a new branch from the main branch.
  2. Set up your local clone using Setting up the project for development.
  3. Make your changes and commit them with a meaningful message.
  4. Push your branch to your forked repository on GitHub.
  5. Create a PR from your branch to the main branch of the original repository.
  6. Wait for the project maintainers to review your PR and provide feedback or approval.
  7. If requested, make any necessary changes and update your PR accordingly.
  8. Once your PR is merged, delete your branch and fork.

Setting up the project for development

Before you can start working on ItsPrompt, you need to do a few things:

  1. Install all required dependencies from requirements.txt and requirements-dev.txt.
  2. Install our pre-commit hooks using pre-commit install in your main project directory.

Providing Feedback

We value your feedback and opinions on this project. You can share them with us by:

  • Joining the Discussions section on GitHub and starting or joining a conversation.
  • Joining our Discord and letting us know what you think.

Thank You

We appreciate your time and effort in contributing to this project. We hope you enjoy using ItsPrompt and find it useful. Thank you for being part of our community!