SolaceCommunity Github Contribution Guide 🎉
📣 We are launching the SolaceCommunity Github organization! This organization offers community supported, authored and maintained open source projects. As our community grows, these projects offer integration with, and ways to use, Solace technologies.
What to contribute
Contributions to the SolaceCommunity Github organization include:
- Projects that provide integrations with Solace and other technologies or platforms
- Tools that enables the usage of Solace APIs (wrappers, packages...etc)
- Projects illustrating the use of Solace APIs for learning or teaching purposes
What it means to contribute a project to the community org
- You are awesome 🎉! Thanks for sharing your project and collaborating with all of us in the community! By doing so you would be a strong contender to receive the "Community Contributor" badge
- The project repo will be transferred (or created) in the SolaceCommunity Github org and is then owned by the Solace Community. To contribute a project contact us at
[email protected]. Note that if you are not the sole owner of a project you must have written permission of all owners prior to transferring.
- Contributors should recommend initial maintainer(s) for the project being contributed. Contributors are often the initial maintainers themselves. These maintainers will have admin level permissions on the individual project repo and do not have to be members of the SolaceCommunity github org itself.
- Contributed project should have a README, license, contribution guide, and code of conduct. Check out this repo template for a recommended way to structure a repo.
- The current maintainer(s) and/or initial creator do NOT have permissions to delete the project after is has been contributed to the community, however stale projects may be archived.
- Owner: Solace DevRel Team will be the owner of all repos in the Solace Community Github Org and have admin access to the repos.
- Maintainer: Maintainer(s) are specified for each repo. They have maintain permissions as defined by github to the repo and control the direction of the project including management of open issues on PRs. They can customize the repository to best fit to the contribution process they would like. This includes things such as customizing the contribution guide, roles of contributors and modifying the available issue types.
- Contributors: Any public github user has the ability to contribute via Pull Requests. No special permission is necessary. Maintainers may choose to give frequent contributors to a repo an assigned github role (such as write or triage)
- Is your tool an npm package? You can publish it to @solace-community npm org scope!
- Is your tool a docker image? You can push it to @solacecommunity on dockerhub!
We have more projects coming up! Stay tuned and let us know below if you are interested to use any of those public tools or if you see yourself contributing with any project!