mirror of
https://github.com/cverinc/marktile.git
synced 2026-07-22 07:42:21 +00:00
493d7c0c97
The plugin source is open-sourced at github.com/CVERInc/tile (MIT). This repo stays the release mirror; code PRs now go to the source repo instead of the old issue-only flow.
31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
# Contributing to marktile
|
|
|
|
Thanks for your interest! marktile is an open-source Obsidian plugin by [CVER Inc.](https://cver.net)
|
|
|
|
## Reporting bugs & requesting features
|
|
|
|
Please open a [GitHub issue](https://github.com/CVERInc/marktile/issues). Helpful details:
|
|
|
|
- Obsidian version, and your OS / device (desktop, iOS, Android)
|
|
- Steps to reproduce, and what you expected instead
|
|
- A small sample of the Markdown when it's relevant
|
|
|
|
## Pull requests
|
|
|
|
The built files here (`main.js`, `styles.css`, `manifest.json`) are generated from
|
|
source, so this repo is the release home — not where code changes are made. **The source
|
|
is open at [CVERInc/tile](https://github.com/CVERInc/tile)** (MIT): the shared editor
|
|
engine and both Obsidian plugins live there, and that is where code pull requests go.
|
|
Clone it, run `bash scripts/test.sh`, then PR against it.
|
|
|
|
Documentation wording and translation suggestions are very welcome.
|
|
|
|
## Translations
|
|
|
|
marktile ships English, 日本語, 한국어, and 繁體中文. To add or correct a locale, open an
|
|
issue with the strings and we'll wire it in.
|
|
|
|
## License
|
|
|
|
By contributing you agree your contributions are licensed under the repository's
|
|
[MIT License](LICENSE).
|