Getting Involved
We’re excited to welcome contributors, users, and cloud platform enthusiasts to the Platform Specification project. This is a community-driven initiative aimed at building a standardized approach for defining, deploying, and managing cloud platforms. We value contributions in all forms, from code and documentation improvements to feedback and discussions.
Here’s how you can get involved and contribute to the project.
How to Get Involved
1. Explore and Engage via GitHub Discussions
We use GitHub Discussions as our primary forum for conversations about the Platform Specification. Whether you’re a newcomer or a seasoned platform engineer, feel free to join the discussions. This space allows you to:
- Ask questions about the project.
- Share ideas or proposals for new features.
- Discuss best practices and approaches for cloud platform engineering.
- Engage with other community members.
We encourage everyone to participate actively in discussions and help build a vibrant community around the Platform Specification.
2. Report Issues and Suggest Enhancements via GitHub Issues
Found a bug? Have a suggestion for an improvement? Our GitHub Issues page is the place to go. You can:
- Report bugs or issues you encounter while using the Platform Specification.
- Propose new features or enhancements.
- Suggest updates or changes to the specification.
- Contribute to ongoing discussions around existing issues.
Make sure to check if the issue already exists before creating a new one. If it does, feel free to join the conversation and add your input.
3. Contribute Code and Documentation via Pull Requests
If you’re ready to contribute code or documentation, you can submit a pull request (PR). Here’s how to get started:
- Fork the repository and clone it locally.
- Create a new branch for your work.
- Implement your changes, making sure to follow the project’s conventions.
- Push your changes and submit a pull request.
We review all pull requests carefully and work with contributors to ensure that every change is aligned with the project’s goals. Please include relevant tests and updates to documentation as needed.
Details for how to work on the actual code base are described in the project README.md.
How to Start Contributing
If you're new to open-source contributions, here are a few simple steps to get started:
Familiarize Yourself with the Project: Read through the existing documentation and issues to understand the current state of the Platform Specification.
Ask Questions: If you're unsure about something, don’t hesitate to ask questions in GitHub Discussions or comment on an issue for clarification.
Submit Your Contribution: Once you're comfortable, follow the contribution process mentioned earlier and submit your pull request!
Code of Conduct
We strive to create an inclusive and welcoming environment for all participants. Please be respectful and considerate in all your interactions. We follow the Contributor Covenant Code of Conduct, and we expect all contributors to do the same.
Stay Updated
Stay in the loop with updates and new releases by:
- Watching the repository on GitHub for notifications.
- Joining the conversations on GitHub Discussions.
- Subscribing to updates on issues or pull requests that interest you.
We look forward to your contributions and involvement in the Platform Specification project! Together, we can build a standardized approach to cloud platforms that benefits the entire cloud-native community.
If you have any questions or need help getting started, feel free to reach out via GitHub Discussions.
Questions
If you have any general questions, please reach out to contact@platformspec.io.