Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (53 loc) · 4.52 KB

CONTRIBUTING.md

File metadata and controls

82 lines (53 loc) · 4.52 KB

Contributing to Cliprompt

First off, thank you for considering contributing to Cliprompt. It's people like you that make Cliprompt such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

What kinds of contributions we're looking for

Cliprompt is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Cliprompt itself.

Ground Rules

Responsibilities:

  • Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, and Linux.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • Keep feature versions as small as possible, preferably one new feature per version.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.

Your First Contribution

Unsure where to begin contributing to Cliprompt? You can start by looking through these beginner-friendly and help-wanted issues:

  • Beginner-friendly issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner-friendly issues.

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸

Getting started

For something that is bigger than a one or two line fix:

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. If you like the change and think the project could use it:
    • Be sure you have followed the code style for the project.
    • Send a pull request.

Small contributions such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted by a contributor as a patch.

As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. As long as the change does not affect functionality, some likely examples include the following:

  • Spelling / grammar fixes
  • Typo correction, white space and formatting changes
  • Comment clean up
  • Bug fixes that change default return values or error codes stored in constants
  • Adding logging messages or debugging output
  • Changes to 'metadata' files like package.json, .gitignore, build scripts, etc.
  • Moving source files from one directory or package to another

How to report a bug

Security Issues

If you find a security vulnerability, do NOT open an issue. Email the maintainer directly instead.

Any security issues should be submitted directly to the project maintainer. In order to determine whether you are dealing with a security issue, ask yourself these two questions:

  • Can I access something that's not mine, or something I shouldn't have access to?
  • Can I disable something for other people?

If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, please contact the maintainer.

Bug Reports

When filing an issue, make sure to answer these questions:

  1. What version are you using?
  2. What operating system and processor architecture are you using?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?

How to suggest a feature or enhancement

If you find yourself wishing for a feature that doesn't exist in Cliprompt, you are probably not alone. There are bound to be others out there with similar needs. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.

Code review process

The core team looks at Pull Requests on a regular basis. After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.

Community

You can chat with the core team by opening a discussion on GitHub Discussions.