mirror of
https://github.com/webadderallorg/Recordly.git
synced 2026-11-09 23:43:35 +00:00
108 lines
4.5 KiB
Markdown
108 lines
4.5 KiB
Markdown
# 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](./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:
|
|
```bash
|
|
git clone https://github.com/your-username/Recordly.git
|
|
```
|
|
|
|
3. **Create a New Branch**
|
|
- Create a branch for your feature or bug fix:
|
|
```bash
|
|
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:
|
|
```bash
|
|
git add .
|
|
git commit -m "Add a brief description of your changes"
|
|
```
|
|
|
|
7. **Push Your Changes**
|
|
- Push your branch to your forked repository:
|
|
```bash
|
|
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](https://github.com/webadderallorg/Recordly/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.
|
|
|
|
## Contribution terms
|
|
|
|
Recordly accepts contributions under the terms below. They give the Recordly project
|
|
owner explicit rights to offer both open-source and separately licensed official
|
|
builds. Contributors retain ownership of their contributions.
|
|
|
|
### Copyright permissions
|
|
|
|
By expressly accepting these terms for a contribution, you grant `webadderall`, the
|
|
Recordly project owner, a worldwide, perpetual, irrevocable, non-exclusive,
|
|
royalty-free copyright license to use, reproduce, modify, prepare derivative works
|
|
of, publicly display, publicly perform, distribute, and sublicense your contribution
|
|
and derivative works, in source or binary form.
|
|
|
|
This grant expressly permits the project owner to distribute and sublicense your
|
|
contribution under the [GNU Affero General Public License v3.0](./LICENSE.md)
|
|
and under other licenses, including commercial or proprietary licenses, without
|
|
requiring further permission or payment to you. It includes permission to offer
|
|
official Recordly downloads free for personal use and under paid terms for business
|
|
use. The project owner may transfer this grant to a successor owner of Recordly.
|
|
|
|
Your contribution is also provided under the project's AGPLv3 license. The additional
|
|
grant to the project owner does not remove rights already granted to recipients
|
|
under AGPLv3. These contribution terms do not themselves change the license of an
|
|
existing Recordly release or establish that every component can be commercially
|
|
relicensed.
|
|
|
|
### Your authority to contribute
|
|
|
|
You confirm that you own the rights needed to make these grants or are authorized
|
|
by the rights holder, including your employer where applicable. Identify any
|
|
third-party code, assets, or other material included in your submission and provide
|
|
their original licenses and required notices. These terms do not override those
|
|
third-party licenses or grant rights you do not hold.
|
|
|
|
### Acceptance and existing contributions
|
|
|
|
For new submissions after these terms are published, explicitly confirm your
|
|
acceptance in the pull request using the contribution-terms checkbox. Maintainers
|
|
must verify that acceptance before merging; an unchecked template is not consent.
|
|
For contributions made outside a pull request, record equivalent written acceptance
|
|
identifying the contribution.
|
|
|
|
These terms apply to the contributions identified in an accepted submission.
|
|
Changing this guide does not retroactively obtain additional rights over earlier
|
|
contributions. Earlier contributions require their existing license permissions or
|
|
separate agreement from the relevant rights holder.
|
|
|
|
Thank you for your contributions!
|