First off, we are super excited that you are willing to improve Glide 馃檶
There are three areas to contribute:
- Technical: Help us to improve existing functionality, fix bugs, and bring on new features both to Glide and related repositories like Python SDK.
- Documentation: Improve documentation content, uncover undocumented features & gotchas, write guides and walkthroughs.
- Vision: Help us to uncover use cases where Glide could have helped that might be useful for a broader set of people
We value your time. To make your onboarding as smooth as possible while reducing amount of back and forth, we coordinate and communicate in the EinStack's Discord space before jumping on anything major.
Overcommunication is the key to solving many problems.
We are using enhancement proposals to define bigger problems and suggest our solutions to them.
The enhancement proposals share your ideas on solving the problem and let other people give a feedback, identify areas to investigate, brainstorm alternatives.
To start a new GEP, you don't have to know all the answers to all questions. You can outline gaps and let other people contribute their ideas on possible solutions.
Many useful commands are in the root makefile. We use make as a convenient interface to automate a bunch of commands like codebase linting, running tests, running dev binary, etc. Be sure to take a look at all available commands.
All important checks are automated on the level of pull request checks. Be sure to keep your PRs green, before moving the PR to the review stage.
If you spot a typo or incorrect information, please do use the raise issue or suggest edits functionality directly on the documentation page.
If you see some uncovered functionality, please fill briefly a Github issue.
A special place takes our guides. Guide is a walkthrough that solves a concrete use case or problem step by step.
To inspire our end users and illustrate the true capabilities of Glide, we want to grow the number of guides.
If you have any specific use cases to cover, please do let us know in Discord or our docs repo (even if you don't have a chance to work on that).
If you feel like we have overlooked some useful functionality or features that would be great to have, feel free to create a new discussion in our Github Discussions.
We will review and discuss all ideas and will try to fit them into the Glide's roadmap.
That's perfectly fine!
Feel free to connect with us in Discord and ask any question you have. Remember, there are no dumb questions, but there can be missing opportunities to make your life easier if you don't speak up about things you struggle with.
EinStack uses Github functionality to do all sorts of management and planning of Glide functionality:
- We use Github Projects to manage the Glide's roadmap
- We use Github issues to manage epics (e.g. bigger functionality that would not fit one task or pull request) and the corresponding tasks
- Github issue labels to indicate epic priority and other horizontal properties of the functionality like type, area, etc
- Github milestones to assign epics to upcoming releases which may be connected to Glide incremental releases or solve some specific use case (e.g. RAG)
You can do that by:
- creating a new Github issue
- assigning the
type:epicto it - adding it to the Glide Roadmap project (the backlog status)
Be sure to let everyone know about this in the EinStack Discord (#general channel is fine).