Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

69 lines (45 loc) · 2.83 KB
Raw

Contributing to prompt-ez

We're thrilled that you're interested in contributing to prompt-ez! This document provides guidelines for contributing to the project. By participating in this project, you agree to abide by its terms.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to [insert contact email].

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for prompt-ez. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for prompt-ez, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps or point out the part of prompt-ez where the enhancement could be implemented.
  • Explain why this enhancement would be useful to most prompt-ez users.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Follow the TypeScript styleguide
  • Include thoughtfully-worded, well-structured tests as needed
  • Document new code based on the Documentation Styleguide
  • End all files with a newline

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

TypeScript Styleguide

All TypeScript code is linted with ESLint. Ensure your code adheres to the project's ESLint configuration.

Documentation Styleguide

  • Use Markdown for documentation.
  • Reference methods and classes in markdown with the custom {} notation:
    • Reference classes with {ClassName}
    • Reference instance methods with {ClassName.methodName}
    • Reference class methods with {ClassName.methodName}

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that are bugs.
  • enhancement - Issues that are feature requests.
  • documentation - Issues or pull requests related to documentation.
  • good first issue - Good for newcomers.

Thank you for contributing to prompt-ez!