Files
Recordly/CONTRIBUTING.md
sharkcreep87 df3527c1e9 chore: update repository URLs to canonical webadderallorg org (#402)
The repo was moved from github.com/webadderall to github.com/webadderallorg
but several files still reference the old URL. GitHub serves a 301
redirect today, but package.json metadata, the Homebrew cask, and the
in-app issues link should point to the canonical location.

Updated:
- package.json (homepage, repository.url, bugs.url)
- README.md and README.zh-CN.md (releases / clone / issues links)
- CONTRIBUTING.md (issues link)
- recordly.rb (Homebrew cask url + homepage)
- src/components/video-editor/TutorialHelp.tsx (RECORDLY_ISSUES_URL)
- src/components/video-editor/videoPlayback/motionSmoothing.ts (attribution comment)
2026-05-02 12:08:28 +10:00

2.1 KiB

Contribution Guidelines

Thank you for considering contributing to this project! By contributing, you help make this project better for everyone. Please take a moment to review these guidelines to ensure a smooth contribution process.

Areas where help is especially valuable:

  • Export optimisations
  • Native screen recording for Linux
  • Wallpaper submissions
  • Extensions (device frames, click effects, render hooks — see EXTENSIONS.md)

How to Contribute

  1. Fork the Repository

    • Click the "Fork" button at the top right of this repository to create your own copy.
  2. Clone Your Fork

    • Clone your forked repository to your local machine:
      git clone https://github.com/your-username/Recordly.git
      
  3. Create a New Branch

    • Create a branch for your feature or bug fix:
      git checkout -b feature/your-feature-name
      
  4. Make Changes

    • Make your changes.
  5. Test Your Changes

    • Test your changes thoroughly to ensure they work as expected and do not break existing functionality.
  6. Commit Your Changes

    • Commit your changes with a clear and concise commit message:
      git add .
      git commit -m "Add a brief description of your changes"
      
  7. Push Your Changes

    • Push your branch to your forked repository:
      git push origin feature/your-feature-name
      
  8. Open a Pull Request

    • Go to the original repository and open a pull request from your branch. Provide a clear description of your changes and the problem they solve.

Reporting Issues

If you encounter a bug or have a feature request, please open an issue in the Issues section of this repository. Provide as much detail as possible to help us address the issue effectively.

Style Guide

  • Write clear, concise, and descriptive commit messages.
  • Include comments where necessary to explain complex code.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions!