Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (21 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.74 KB

Contributing to ScreenArc

First off, thank you for considering contributing to ScreenArc! It's people like you that make open source such a great community.

How Can I Contribute?

  • Reporting Bugs: If you find a bug, please open a new issue using the "Bug Report" template.
  • Suggesting Enhancements: Have an idea for a new feature? Open an issue using the "Feature Request" template.
  • Pull Requests: If you're ready to contribute code, please follow the workflow below.

Your First Code Contribution

Unsure where to begin? You can start by looking through good first issue and help wanted issues.

Contribution Workflow

  1. Fork the repository: Create your own copy of the project on GitHub.
  2. Clone your fork: git clone https://github.com/tamnguyenvan/screenarc.git
  3. Create a branch: git checkout -b feature/your-amazing-feature or fix/issue-number. Please use a descriptive branch name.
  4. Install dependencies: npm install
  5. Make your changes: Write your code and make sure it works by running the app locally (npm run dev).
  6. Lint your code: Run npm run lint to check for any style issues.
  7. Commit your changes: Please use the Conventional Commits format for your commit messages. This helps us automate changelogs and versioning.
    • feat: Add webcam overlay feature
    • fix: Correctly handle multi-monitor recording on Windows
    • docs: Update README with installation instructions
  8. Push to your fork: git push origin feature/your-amazing-feature
  9. Open a Pull Request: Go to the original ScreenArc repository and open a PR from your forked branch. Please fill out the PR template with as much detail as possible.