self-hosted/STARK
1
0
Fork 0
mirror of https://github.com/MarkParker5/STARK.git synced 2025-02-12 11:46:14 +02:00
Code Issues Releases Activity

contributing-and-shared-usage-stark-place

Browse Source
This commit is contained in:
Mark Parker 2023-09-18 08:34:21 +02:00
parent 0bf42dff25
commit 5c410b0b65
No known key found for this signature in database
GPG Key ID: C10A60786A07A300
1 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/contributing-and-shared-usage-stark-place.md
View File

@ -1,10 +1,32 @@
# Contributing and Shared Usage
# Contributing and Shared Usage: S.T.A.R.K. P.L.A.C.E.
[STARK-PLACE](https://github.com/MarkParker5/STARK-PLACE) repository is a platform library with community extensions. Use commands created by others and feel free to share yours!
**STARK Platform Library and Community Extensions**
Stark-Place serves as a repository filled with commands, implementations of various protocols (like speech interfaces), and other extensions that enhance the capabilities of the Stark framework. These features are systematically structured into modules, categorized based on their functionality.
### 📦 Using Stark-Place
To integrate features from Stark-Place into your projects:
1. Install it as you would with any pip module.
2. Import the `general_manager` for access to all commands or the specific manager from a module, or any other feature you require.
### 🤝 Contributing to Stark-Place
We welcome and appreciate contributions from the community! Here's how you can contribute:
1. **Fork the Repository**: Start by creating a fork of the [MarkParker5/STARK-PLACE](https://github.com/MarkParker5/STARK-PLACE) repository.
2. **Optional Branch Creation**: If you prefer, you can create a branch within your fork to manage your changes.
3. **Add Commands or Features**: Either add commands to an existing module or create a new module.
4. **Push Your Changes**: Once you're satisfied with your additions or modifications, push them to your fork.
5. **Open a Pull Request**: Finally, head over to the main STARK-PLACE repository and open a pull request. We'll review your contributions and merge them!
### License
Project is licensed under
The Stark-Place project is licensed under the [CC BY-NC-SA 4.0 International license](https://github.com/MarkParker5/STARK-PLACE/tree/master/LICENSE.md). You're welcome to modify, contribute to the repository, create, and share forks. Just remember to attribute the original repository and its creator, abstain from commercial use, and retain the existing license.
**Note**: Failing to provide the attribution or using the project for commercial purposes breaches the licensing terms and could have legal consequences.
---
We're thrilled to have you as part of our community, and we're excited to see the innovative extensions you'll bring to Stark-Place! Remember, every contribution, big or small, helps in shaping Stark-Place into a powerful platform for all Stark users. Join the community, share your expertise, and let's build together!