Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (25 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.43 KB

Contributing to Gravity Recorder

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

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

  • Check for existing issues: Before opening a new issue, please check if the bug has already been reported.
  • Provide details: Use our Issue Template to provide as much context as possible.

Suggesting Enhancements

  • Open an issue: Explain the feature you'd like to see and why it would be useful.

Pull Requests

  1. Fork the repository and create your branch from master.
  2. Install dependencies: npm install.
  3. Make your changes.
  4. Ensure the code builds: npm run build.
  5. Submit a Pull Request with a clear description of your changes.

Branching Strategy

  • master: The stable version of the app. Do not push directly to this branch.
  • feature/* or fix/*: Use these branches for your work.

PR Verification Process

All Pull Requests will be reviewed by the maintainer (@uzairkath). No code will be merged into master until it has been:

  1. Reviewed for quality and security.
  2. Verified locally for functionality.
  3. Approved by the maintainer.

Thank you for helping us build the future of screen recording!