Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added Contribution types, Resolves Add contribution guidelines #38 #132

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added Contribution types, Resolves Add contribution guidelines #38 #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 111 additions & 45 deletions src/content/docs/contributing/types.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Contribution types
description: Explore CommerceQuest's comprehensive documentation to our community
description: Learn about the different ways you can contribute to the Spryker ecosystem
sidebar:
label: Contribution types
order: 1
Expand All @@ -15,70 +15,136 @@ import {
TabItem,
} from "@astrojs/starlight/components";

Welcome to CommerceQuest Docs! We're excited to help you get started with our community. Our guides are designed to introduce you to our community programs, help you understand the basics, and get you started in whichever way or form you want to contribute. Let's jump right in!
# Igniting Community 💥 Celebrating Contributors 🥳

{/* ## Setup Instructions
<Card>
Spryker's pull request and contributions process offers fast acknowledgment of contributed code or documentation updates. We’re excited to continue a new era of collaborative development with the wider Spryker community!
</Card>

<Steps>
<CardGrid stagger>
<Card title="Platform Contributions" icon="document">
Core product enhancements including bug fixes, improvements, and documentation updates.
[Learn more about Platform Contributions](#platform-contributions)
</Card>

<Card title="Innovation Lab" icon="rocket">
Experimental use cases, hackathon projects, tools, and customer & partner innovations.
[Learn more about Innovation Lab](#innovation-lab)
</Card>
</CardGrid>

1. Unboxing Icon Unbox Your CommerceQuest Tools
Carefully open the packaging and verify all components are present. Familiarize yourself with the tool and any accessories.
## Platform Contributions

2. Safety Check Icon Initial Setup and Safety Checks
Read the safety manual before handling the tool. Check the tool for any shipping damage and ensure safety guards are in place.
Platform Contributions are ecosystem-led contributions to be built into and enhance Spryker's core product. These include bug fixes, core improvements, and documentation updates across Spryker's product portfolio.

3. Calibration Icon Calibration and Preparation for First Use
Follow the manufacturer's instructions to calibrate your tools as required. Ensure batteries are charged or electrical connections are secure.
All Platform Contributions can be submitted as pull requests towards the dedicated GitHub repositories related to the Spryker GitHub organizations below.

</Steps> */}
### How to Contribute Platform Contributions

On this site you can find the docs for anything related to our community programs, events, and resources.
For the technical ducumentation of the software projects, please refer to the respective project documentation:
#### Spryker Cloud Commerce OS (SCCOS) and development tools

<CardGrid stagger>
- [Contribution Guidelines](https://docs.spryker.com/docs/dg/dev/code-contribution-guide.html)
- [Documentation](https://docs.spryker.com/docs/scos/user/intro-to-spryker/intro-to-spryker.html)

<Card title="Spryker" icon="star">
A B2B, B2C and marketplace solution renowned for its ease of use, flexibility, and speed. It is the most modern cloud native platform-as-a-service (PaaS) solution. Headless, API based and enterprise-ready.
\
[Spryker Documentation](https://docs.spryker.com/)
</Card>
#### Updating Documentation (SCCOS)

Spryker Documentation accepts contributions in the form of edits and new documents.

To edit existing documents, contributors can use the "Edit on GitHub" button in [Spryker Documentation](https://docs.spryker.com/) and create pull requests with suggestions.

To create a new document, contributors can create pull requests directly to the relevant [Spryker doc repository](https://github.com/spryker/spryker-docs).

Alternatively, the following guides are available to advise on how to create pull requests toward documentation:
- [Edit Documentation via a Web Browser](https://docs.spryker.com/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/edit-documentation-via-pull-requests.html)
- [Edit Documentation Locally](https://docs.spryker.com/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/edit-the-documentation-locally.html)

## Innovation Lab

Innovation Lab contributions are ecosystem-led submissions demonstrating innovative but often experimental use cases built for use with Spryker.

These include hackathon projects, tools, and customer & partner innovation ideas. They may be utilized in any part of the Spryker platform, including the products listed above.

### How to Contribute to Innovation Lab

There are two distinct ways to contribute to Innovation Lab:

#### 1. Ask Spryker to create a repository within the [Spryker Community & Innovation Lab GitHub organization](https://github.com/spryker-community)

- Request access by e-mailing [[email protected]](mailto:[email protected]) or post your request in the [Community Projects CommerceQuest subforum](https://commercequest.space/categories/spryker-community-projects).
- Once you have access, begin your project and upload your first code!
- And, of course, we encourage everyone to evaluate current projects, suggest improvements, or even submit pull requests!

<Card title="Oryx" icon="star">
Open Source framework empowering developers to build composable frontends with ease by providing a rich library of components, which lets developers create modern and visually appealing UI.\
[Oryx Documentation](https://docs.spryker.com/docs/dg/dev/frontend-development/202404.0/oryx/oryx.html)
#### 2. Create an Innovation in your own organization

- Create an Innovation Lab repository in your own GitHub organization and communicate with the Spryker team to have this reviewed. Reviews can be requested by e-mailing [[email protected]](mailto:[email protected]), or post your request in the [Community Projects subforum](https://commercequest.space/categories/spryker-community-projects) in [CommerceQuest](https://commercequest.space/).
- If your Innovation is accepted, we will mirror it with the [Spryker Community & Innovation Lab GitHub organization](https://github.com/spryker-community) and add your contribution to our [Community Tools](https://commercequest.space/community-tools/) list to allow other Spryker developers to find it.

[Contribution Guidelines](https://github.com/spryker-community/docs/blob/main/CONTRIBUTE.md) need to be followed in both cases listed above.

<Aside type="note">
Innovation Lab submissions are not ordinarily maintained by Spryker, with no commitment or legal obligation for this to take place.
</Aside>

---

## Contributing Process

### Submission Review

<Card>
Spryker endeavors to have all submissions acknowledged within two weeks. Submissions will be accepted or returned with feedback.
</Card>

### Rewards and Recognition

Spryker will be leveraging a point system to reward contributors. Points will accumulate to enable contributors to receive achievements and acknowledgments.

<CardGrid>
<Card title="Bronze Badge">
Shout-out in the CommerceQuest monthly newsletter.
</Card>

<Card title="Propel" icon="star">
An open-source Object-Relational Mapping (ORM) for SQL-Databases in PHP8. Highly customizable and blazing fast.\
[Propel Documentation](https://propelorm.org/)
<Card title="Silver Badge">
Spryker merchandise.
</Card>
</CardGrid>

<Card title="Gold Badge">
Rewards to be revealed!
</Card>

## Want to contribute to our community documentation?
<Card title="Diamond Badge">
Rewards to be revealed!
</Card>
</CardGrid>

<Aside type="tip">
You can easily edit this documentation on GitHub. Simply click the "Edit page" link that is shown at the bottom of each page to make changes directly on GitHub. If it's your first time doing this, you can find more information on how to contribute in our [Content Contributions guide](https://github.com/spryker-community/spryker-community.github.io?tab=readme-ov-file#contributing).
Please include a link to your GitHub in your [CommerceQuest profile](https://commercequest.space/) so we can match contributors to users on our community platform.
</Aside>

It's a community effort to keep our documentation up to date and accurate. If you find an error or have a suggestion for improvement, we encourage you to contribute. Your feedback helps us maintain the highest quality documentation for our users. 🙏
### Support

We value every contribution to our ecosystem. Contributors receive:

## Additional Resources
- Recognition in our community
- Opportunities to showcase their work
- Access to exclusive community events
- Direct interaction with the Spryker team
- Potential feature highlights in our release notes

<LinkCard
title="Community YouTube Channel"
description="Here you will find recordings from our Community events and announcements."
href="https://www.youtube.com/watch?v=dK7SeH7t5MQ&list=PLJooqCSo73SiPKM3mlZzc7lGq5zEFQkRS"
/>
<Aside type="note">
Have questions or need help? Reach out to our community team at [[email protected]](mailto:[email protected]) or join our [Slack](https://join.slack.com/t/sprykercommunity/shared_invite/zt-2r8nyxl84-SFMyKuJ8IjFBtk0~BvWX~w) or [Discord server](https://discord.gg/kjrdurASgX) for real-time support.
</Aside>

<LinkCard
title="Spryker Documentation"
description="The best place to go for any technical questions or issues you may have around Spryker development"
href="https://docs.spryker.com/"
/>
## Getting Started

<LinkCard
title="Spryker Safari"
description="Our brand new learning experience for all things Spryker. Dive into the world of Spryker with our interactive learning platform."
href="https://safari.spryker.com/"
/>
<Steps>
1. Join our [CommerceQuest community](https://commercequest.space/) to stay up to date via our [dedicated thread](https://commercequest.space/discussion/28836/reenergizing-our-contribution-and-pull-request-processes).
2. Add your GitHub profile link to your CommerceQuest profile so we can match contributors to contributions, award badges, and give shout-outs!
3. Submit your pull requests for acknowledgment and review!
4. Keep an eye on Spryker's communication channels, including CommerceQuest, for shout-outs and further updates!
5. Bookmark this guide! All updates will be reflected here.
</Steps>

<Card>
Spryker is beyond excited to reinvigorate our collaborative processes, charting new horizons hand-in-hand with our esteemed developer community! We look forward to receiving and recognizing your awesome submissions, helping to shape the future of commerce technology together!
</Card>