Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 4.02 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 4.02 KB

Contribution Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Issues

Before reporting a bug, please check our list of open issues to see if someone has already reported the bug. If it's an open issue, please add any additional information that you think might be helpful. If it's not, please create a new issue and include as much information as you can. Information like a detailed description of the issue, steps to reproduce the issue, and any error messages are incredibly helpful.

Suggesting Enhancements

If you have ideas for improvements or new features we would love to hear them. Please provide as much detail as possible so we can fully understand your ideas. You can create a new issue to share your suggestions.

Self Assigning Issues

  1. To express interest in working on an issue, simply type /attempt at the beginning of a comment.
  2. If the issue is unassigned, it will be automatically assigned to you. ✨
  3. If the issue is already assigned, you'll receive a message indicating the need to contact a maintainer to discuss reassignment.

Example: /attempt I'd like to work on this issue.

Code Contribution

Please ensure your pull request adheres to the following guidelines:

  • Search the open pull requests to ensure someone else has not already submitted the change.
  • Make sure your code follows the style guidelines of the project. For TypeScript, we use ESLint and Prettier for formatting.
  • Make sure your code passes all the project's tests. You can run tests using pnpm run test.
  • For setting up the project, do check the Getting Started guide.
  • Write good commit messages by following conventional commits.
  • Include relevant issue number if applicable.
  • Your PR should follow this pattern: fix|feat|chore|docs|style|refactor|perf|test|ci|build|breaking-change|revert: <description>. For example, feat: add new feature or fix: fix a bug. Note that description can contain only alphanumeric characters and -, . and _ characters.
  • Before you make a push to your branch, make sure you rebase your branch with the latest changes from the develop branch.

Testing your changes

  • Run your changes locally for testing purposes
  • Run the project in development mode to confirm your changes work as expected: pnpm run dev.
  • Use debug logging when reproducing and fixing issues to inspect what's happening under the hood: DEBUG=* pnpm run dev keyshade run "your-command-here" Example use case: Automated tests don't always catch integration issues or problems that only surface in a live environment. Debug logging can reveal issues like malformed API requests or unexpected data flow that would otherwise be invisible.

Documentation

We love documentation contributions! Whether it's more complete descriptions, new examples, or better formatting, any help improving the documentation is appreciated.

Community

You can chat with the core team on our discord. Please be respectful to each other and follow our code of conduct.

Thank you again for your interest in our project, your contribution, and your support!

Your Project Team