Skip to content

Commit 85ed02e

Browse files
committed
docs: readme contributing/author/license; add CONTRIBUTING.md
Drop Brand images section; fix issue links to md2pdf repo.
1 parent 25b3ba0 commit 85ed02e

2 files changed

Lines changed: 36 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing
2+
3+
Thanks for your interest in **Markdown2PDF**.
4+
5+
## Issues
6+
7+
Bug reports and feature requests are tracked on [GitHub Issues](https://github.com/marcop135/md2pdf/issues). Include steps to reproduce, expected vs actual behavior, and your browser or OS when reporting bugs.
8+
9+
## Pull requests
10+
11+
1. Fork the repo and create a focused branch (`feature/…` or `fix/…`).
12+
2. Match existing code style (formatting, patterns, naming).
13+
3. Run **`yarn test`** before pushing; **`yarn build`** should succeed for UI changes when relevant.
14+
4. Keep commits and the PR description clear; link related issues when applicable.
15+
16+
## Attribution
17+
18+
This project derives from [realdennis/md2pdf](https://github.com/realdennis/md2pdf) (MIT). Respect upstream licensing and preserve copyright notices where you touch substantial upstream-derived files.
19+
20+
## What we are unlikely to merge
21+
22+
- Breaking changes without discussion.
23+
- Dependencies that materially grow the bundle without clear benefit for this offline-first scope.
24+
- Server-side uploads or backends (out of scope for this app).
25+
26+
Questions are welcome via issues before large refactors.

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -112,19 +112,18 @@ graph TD
112112
| `yarn test` | Run tests |
113113
| `yarn preview` | Preview production build (`dist/`) |
114114

115-
## Contributing
115+
## 🤝 Contributing
116116

117-
1. Fork the repository.
118-
2. Create a branch: `git checkout -b feature/your-feature`.
119-
3. Commit: `git commit -m 'Describe your feature'`.
120-
4. Push: `git push origin feature/your-feature`.
121-
5. Open a pull request.
117+
Contributions welcome! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to contribute.
122118

123-
## Brand images
119+
- 🐛 Found a bug? [Open an issue](https://github.com/marcop135/md2pdf/issues)
120+
- 💡 Have a feature request? [Open an issue](https://github.com/marcop135/md2pdf/issues)
121+
- 📝 Want to contribute? [Read the contributing guide](./CONTRIBUTING.md)
124122

125-
- [`docs/readme-hero.png`](docs/readme-hero.png) banner used at the top of this README (UI mockup of the editor and preview).
126-
- [`docs/github-social-preview.png`](docs/github-social-preview.png) for the repository share card on GitHub: **Settings → General → Social preview → Edit** and upload this file (wide image, suitable for repo links and Open Graph-style previews).
123+
## 👤 Author
127124

128-
## License
125+
[Marco Pontili](https://marcopontili.com)
129126

130-
MIT
127+
## 📝 License
128+
129+
Licensed under the [MIT](./LICENSE) License.

0 commit comments

Comments
 (0)