|
| 1 | +# Contributing to MdBundle for Zotero |
| 2 | + |
| 3 | +Thank you for your interest in contributing! Here's how you can help: |
| 4 | + |
| 5 | +## Reporting Bugs |
| 6 | + |
| 7 | +1. Check if the issue already exists in [Issues](https://github.com/wcmendes/MdBundle-for-Zotero/issues) |
| 8 | +2. Open a new issue with: |
| 9 | + - Your Zotero version (e.g., 9.0.6) |
| 10 | + - Your OS (Windows/macOS/Linux) |
| 11 | + - Steps to reproduce the bug |
| 12 | + - Expected vs actual behavior |
| 13 | + - Error Console output if available (Tools → Developer → Error Console) |
| 14 | + |
| 15 | +## Suggesting Features |
| 16 | + |
| 17 | +Open an issue with the `enhancement` label describing your use case and proposed feature. |
| 18 | + |
| 19 | +## Translations |
| 20 | + |
| 21 | +We welcome translations! To add a new language: |
| 22 | + |
| 23 | +1. Copy `src/locale/en-US/mdbundle.ftl` to `src/locale/<your-locale>/mdbundle.ftl` |
| 24 | +2. Translate all values (keep the keys unchanged) |
| 25 | +3. Add your locale to the `supported` array in `src/mdbundle.js` → `loadStrings()` |
| 26 | +4. Submit a Pull Request |
| 27 | + |
| 28 | +## Code Contributions |
| 29 | + |
| 30 | +1. Fork the repository |
| 31 | +2. Create a feature branch (`git checkout -b feature/my-feature`) |
| 32 | +3. Make your changes in `src/` |
| 33 | +4. Test by building the XPI: `cd src && zip -r ../mdbundle.xpi .` |
| 34 | +5. Install and test in Zotero |
| 35 | +6. Commit and push |
| 36 | +7. Open a Pull Request |
| 37 | + |
| 38 | +## Building |
| 39 | + |
| 40 | +```bash |
| 41 | +cd src |
| 42 | +zip -r ../mdbundle.xpi . |
| 43 | +``` |
| 44 | + |
| 45 | +Then install the XPI in Zotero: Tools → Add-ons → ⚙️ → Install Add-on From File. |
| 46 | + |
| 47 | +## Code Style |
| 48 | + |
| 49 | +- Use tabs for indentation |
| 50 | +- Use `async/await` for asynchronous code |
| 51 | +- All user-facing strings must use the `this.s('key')` i18n system |
| 52 | +- Add corresponding entries to all locale `.ftl` files (at minimum `en-US`) |
0 commit comments