mirror of https://github.com/webadderallorg/Recordly.git synced 2026-09-24 06:46:09 +00:00

Files

T

Mohd Sahil 4fd4813ed9 docs: correct contributor licence to AGPL-3.0 in CONTRIBUTING.md

CONTRIBUTING.md stated that contributions are licensed under the MIT
License and linked to ./LICENSE, but the project ships LICENSE.md
containing the GNU Affero General Public License v3.0, and both the
README and recordly.dev state AGPL-3.0.

Point the section at the licence the project actually uses and fix the
link target, which was broken (LICENSE vs LICENSE.md).

2026-09-18 00:52:37 +05:30

2.1 KiB

Raw Permalink Blame History

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

Fork the Repository
- Click the "Fork" button at the top right of this repository to create your own copy.
Clone Your Fork
- Clone your forked repository to your local machine:
```
git clone https://github.com/your-username/Recordly.git
```
Create a New Branch
- Create a branch for your feature or bug fix:
```
git checkout -b feature/your-feature-name
```
Make Changes
- Make your changes.
Test Your Changes
- Test your changes thoroughly to ensure they work as expected and do not break existing functionality.
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"
```
Push Your Changes
- Push your branch to your forked repository:
```
git push origin feature/your-feature-name
```
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 GNU Affero General Public License v3.0.

Thank you for your contributions!