mirror of
https://github.com/opus-tango/socialdb-sh.git
synced 2026-03-20 03:55:27 +00:00
51 lines
1.9 KiB
Markdown
51 lines
1.9 KiB
Markdown
# Contributing to SocialDB
|
||
|
||
First off, thank you for considering contributing! It’s people like you who make
|
||
this project better for everyone.
|
||
|
||
By contributing to this project, you agree to abide by our Code of Conduct and
|
||
the terms outlined below regarding licensing.
|
||
|
||
## Licensing and Ownership
|
||
|
||
This project is licensed under the **Mozilla Public License 2.0 (MPL-2.0)**.
|
||
|
||
To ensure that we can maintain the project and potentially offer commercial
|
||
support or "Open Core" features in the future, we require all contributors to
|
||
agree to the following:
|
||
|
||
1. **License Grant:** By submitting a Pull Request, you grant the project
|
||
owner(s) a non-exclusive, perpetual, worldwide, royalty-free license to
|
||
use, modify, and redistribute your contribution.
|
||
2. **Dual-Licensing:** You acknowledge that the project owner(s) may choose
|
||
to license the project (including your contributions) under different
|
||
terms, including commercial or proprietary licenses, while the version
|
||
released under MPL-2.0 remains open source.
|
||
3. **Attribution:** You will be credited for your contributions in the
|
||
version control history (Git).
|
||
|
||
---
|
||
|
||
## How Can I Contribute?
|
||
|
||
### Reporting Bugs
|
||
|
||
- Check the **Issues** tab to see if the bug has already been reported.
|
||
- If not, open a new issue. Include a clear title, a description of the
|
||
problem, and steps to reproduce the bug.
|
||
|
||
### Suggesting Enhancements
|
||
|
||
- Open an issue with the tag `enhancement`.
|
||
- Explain the "why" behind the feature and how it would benefit other users.
|
||
|
||
### Pull Requests (PRs)
|
||
|
||
1. **Fork the repo** and create your branch from `main`.
|
||
2. **Ensure your code follows the style guide** (run `npm run lint` or
|
||
equivalent if applicable).
|
||
3. **Write tests** for any new functionality.
|
||
4. **Update documentation** if you are changing how a feature works.
|
||
5. **Sign-off your commits**: We prefer commits to be signed (e.g.,
|
||
`git commit -s`) to confirm you have the right to submit the code.
|