UNPKG

mowascript

Version:

MowaScript language implementation

95 lines (70 loc) โ€ข 2.47 kB
[[๐ŸŒ€ Interslavic](../../07_contribute.md) ยท [๐ŸŒฒ East Slavic](../east/07_contribute.md)] # ๐Ÿค How to Contribute to MowaJS MowaJS is an open-source project inspired by the idea of making programming more accessible for Slavic-language speakers. We warmly welcome new contributors and ideas! --- ## ๐Ÿ“ Repository Structure ``` mowascript/ โ”œโ”€โ”€ bin/ # CLI scripts (mowa.js) โ”‚ โ””โ”€โ”€ mowa.js โ”œโ”€โ”€ dist/ # Compiled JavaScript output โ”œโ”€โ”€ examples/ # Code examples in Mowa โ”œโ”€โ”€ node_modules/ โ”œโ”€โ”€ src/ # Transpiler core โ”‚ โ”œโ”€โ”€ map/ # Dictionaries (by, ua, ru, isv...) โ”‚ โ”‚ โ”œโ”€โ”€ by.js โ”‚ โ”‚ โ”œโ”€โ”€ ua.js โ”‚ โ”‚ โ”œโ”€โ”€ ru.js โ”‚ โ”‚ โ”œโ”€โ”€ isv.js โ”‚ โ”‚ โ””โ”€โ”€ index.js โ”‚ โ””โ”€โ”€ transpile.js # Main transpile logic โ”œโ”€โ”€ templates/ # Templates for `mowa init` โ”‚ โ”œโ”€โ”€ docs/ โ”‚ โ”œโ”€โ”€ src/ โ”‚ โ”œโ”€โ”€ package.json โ”‚ โ””โ”€โ”€ README*.md โ”œโ”€โ”€ LICENSE โ”œโ”€โ”€ NOTICE โ”œโ”€โ”€ package.json โ”œโ”€โ”€ package-lock.json โ”œโ”€โ”€ README.md โ”œโ”€โ”€ README.en.md โ””โ”€โ”€ README.east.md ``` --- ## ๐Ÿ“ฆ Setting Up for Development ```bash git clone https://github.com/your-username/mowajs.git cd mowajs npm install ``` To test the CLI locally: ```bash node bin/mowa.js build ``` --- ## โœ… How to Contribute 1. **Fork the repository** 2. Create a new branch: `git checkout -b feature/your-feature` 3. Make your changes and include comments 4. Open a Pull Request with a clear description --- ## ๐Ÿ’ก Contribution Ideas - ๐Ÿ”ค Add a new language dictionary (e.g., Polish, Serbian) - ๐Ÿงช Add tests for existing constructs - ๐Ÿงฑ Improve the CLI (new commands, flags, etc.) - ๐Ÿ“˜ Add `.mowa` examples to the `examples/` folder - ๐Ÿช„ Refactor core transpiler logic in `transpile.js` --- ## ๐Ÿ›ก Code Style Guidelines - Use `ESM` (`import` / `export` syntax) - Keep dependencies to a minimum - Import only what's needed - Comment your code, especially transformation rules --- ## ๐Ÿ“ฌ Contact - Telegram: [@rio_de_sich](https://t.me/rio_de_sich) - [GitHub Issues](https://github.com/dmitrisi4/mowascript/issues) โ€” for bug reports and feature requests - [Pull Requests](https://github.com/dmitrisi4/mowascript/pulls) โ€” to submit code improvements --- Together, we can build something truly unique for the entire Slavic-speaking dev community ๐Ÿ’™