Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

73 lines (47 loc) · 2.89 KB

Contributing to SnapCut

First off, thank you for considering contributing to SnapCut! It's people like you that make SnapCut such a great tool. We welcome contributions from everyone, whether you're fixing a typo or implementing a new feature.

Code of Conduct

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

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for SnapCut. 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 SnapCut, 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.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the TypeScript and JavaScript styleguides.
  • Include thoughtfully-worded, well-structured tests.
  • 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. Please run pnpm lint before submitting your code.

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

Documentation Styleguide

  • Use Markdown.
  • 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 SnapCut!