How to Contribute
Edit on GitHubIf you're reading this, you're likely an open source fan, which is awesome. Thank you for your interest in contributing to our project. β€οΈ
π Talk to Us First!
Archestra is a project with a full-time core team. While we work hard to make our plans and ideas public, we highly recommend saying "Hi!" to us before you start working on the codebase. There are two main reasons for this:
- We might already have designs or plans related to your idea.
- We can support you during the idea stage, which is much more effective than providing feedback after you've already written the code.
You can find the entire development team in our Slack Community. Just post a message in the #general channel! If you're not sure what to write, hereβs a helpful template:
Hey, my name is {your name}, and I would love to work on {your idea}!
That's it! Taking this simple first step gets you 95% of the way there. Our engineers will jump into the conversation, greet you, and share any relevant context to get you started.
π€ Responsible AI Usage is Welcome
We encourage the use of AI tools to help you contribute!
However, we ask that you use these tools responsibly. We sometimes have to reject contributions that show signs of unreviewed AI-generated code, such as:
- Hard-to-read descriptions and comments.
- Code that doesn't follow the existing patterns and conventions of the project.
- Noticeable signs of rushed or un-reviewed AI generation.
From our perspective, carefully reviewing such a contribution can take longer than implementing the feature ourselves. For this reason, we may close the pull request. If this happens to you, please don't be discouraged. We kindly ask you to rework your changes and open a new pull request when you're ready.