Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 3.11 KB
Raw

Contribution guidelines

We appreciate that you're interested in helping with Prompt Pulse. Before you submit your first PR, please read the following guide. We'd hate to see you work on something that someone else is already working on, something that we agreed not to do or something that doesn't match the project.

Sharing is caring!

You have an idea for new functionality

Awesome! Good ideas are invaluable for every product. Before you start hacking away, please check if there is no similar idea already listed in the issues list. If not, please create a new issue describing your idea. Once we agree on the functionality and architecture, the functionality will be ready for building. Don't hesitate to mention in the issue if you'd like to build the functionality yourself.

You have a suggestion for improving existing functionality

Nothing is perfect. If you have an idea how to improve existing functionality in Prompt Pulse, let us know by submitting an issue in the issues list. Some things are done for a reason, but some are not. Let's discuss what you think and see how Prompt Pulse could be improved for everyone.

You've found a bug

Bugs happen. When you find a bug, please have a look at the issues list to see if a similar bug has already been logged. If not, let us know what doesn't work and how we can reproduce it. If we can't reproduce your bug, we will ask you for clarification, which will only make it longer to fix it.

Fixing typos

Typos are embarrassing! Most PR's that fix typos will be accepted immediately. In order to make it easier to review the PR, please narrow the focus instead of sending a huge PR of fixes.

Tips

Before contributing:

  • ensure that the main branch on your fork is in sync with the original prompt-pulse repository

    # assuming you are in the folder of your locally cloned fork....
git checkout main

# assuming you have a remote named `upstream` pointing to the official **prompt-pulse** repo
git fetch upstream

# update your local main to be a mirror of what's in the main repo
git pull --rebase upstream main

  • create a feature branch for your change. If you'll get stuck on an issue or merging your PR will take a while, this will allow you to have a clean main branch that you can use for contributing other changes

    git checkout -b my-contribution

DO's & DON'Ts

  • DO follow the same project structure as the existing project.
  • DO highlight how the current behavior is broken when fixing bugs.
  • DO keep discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the conversation.
  • DO NOT submit PR's for coding style changes.
  • DO NOT surprise us with big PR's. Instead file an issue & start a discussion so we can agree on a direction before you invest a large amount of time.
  • DO NOT commit code you didn't write.
  • DO NOT submit PR's that refactor existing code without a discussion first.