Thank you for your interest in the Typir project! The following is a set of guidelines for contributing to Typir.
The following communication channels are available:
- GitHub issues - for bug reports, feature requests, etc.
- GitHub discussions - for questions, ideas, announcements, etc.
- Weekly Langium dev meeting - While Typir is independent from Langium in general, you might meet some Typir developers at the Langium dev meetings.
In case you have a question, please look into the provided resources and documentations first. If you don't find any answer there, feel free to use the discussions to get help.
- TypeScript
- NodeJS
- NPM
- Feature requests, ideas: start a new GitHub discussion
- Bug reports: create a new GitHub issue
- Code contributions: see details below
- Create a new branch (or fork) of
main. - Do your changes, add corresponding test cases and comments/documentation and create a PR, which might link to issues or discussions.
- Wait for reviews and approvals, until your PR is merged.
The release process for Typir is described in RELEASE.md.