🤝 Contributing to SwiftWave
First off, thanks for having interest in contributing to SwiftWave! 🎉
We have couple of projects under SwiftWave organization. You can contribute to any of them.
| Project | Description | Tech Stack | GitHub Link | Setup Guide |
|---|---|---|---|---|
| SwiftWave | Core PaaS | Golang | Click Here | Click Here |
| Dashboard | Web interface for SwiftWave. | VueJS, TailwindCSS | Click Here | Click Here |
| UDPProxy | Custom UDP Proxy to forward UDP traffic from outside word to internal services. | Golang | Click Here | Click Here |
| Volume Toolkit | Custom tool to analyze volume size, handle backup and restore of volume. | Golang | Click Here | Click Here |
| Stats Ninja | Custom tool to record resource usage of all server and deployed applications. | Golang | Click Here | Click Here |
| SwiftWave Docs + Landing Page | Official landing page and documentation website | Docusaurus | Click Here | Click Here |
| Quick DNS | Service to provide *.swiftwave.xyz domain for your swiftwave installation | Golang | Click Here | Click Here |
| Distributions | Manages the hosting of Swiftwave Debian & RPM packages. | Python | Click Here | Click Here |
📝 How to Contribute to any of the project
- Fork the repository
- Setup the project locally. Refer the above table for setup guide.
- Make changes
- Commit and push your changes
- Raise a Pull Request
🔍 How to Find Issues to contribute
- You can visit Github of project and check the issues tab.
- If you are looking for beginner friendly issues, you can check the good first issue label.
- If you find any issue on any of the project, you can raise an issue and start working on it.
📌 Guidelines
- Please follow the Code of Conduct while contributing.
- Please follow the Conventional Commit Message Guidelines while writing commit messages.
📌 Need Help?
- You can join our Slack Workspace and ask your queries in #general channel.
- Joining Link : slack.swiftwave.org