Thanks contributing to The Headless Dev!
- Reporting an Issue - how to report typo's, bugs and other issues.
- Contributing Content - how to contribute an article
- Editorial Workflow - how we review and edit your contribution
If you have found a spelling mistake, missing info, or anything that you feel is an issue that should be reported, please create a new issue here on GitHub.
We welcome new articles on a range of topics surrounding headless browser frameworks and more specifically Puppeteer and Playwright. Articles should cover any topic related to practical, day-to-day usage of these frameworks. Here are our guidelines
- Submit articles with a PR on the theheadless.dev repo
- Write articles in markdown and can use the Markdown extensions provided by Vue press
- Add articles to the
postsdirectory as markdown files - Add code examples to the
snippetdirectory as Javascript files and inserted into markdown code blocks using the<< @snippetsyntax - Code examples should cover both Puppeteer and Playwright where applicable
- Add your full name and GitHub username in the relevant
authorandgithubUserfront matter
You can find additional styling guidelines in this dedicated file. Our team will gladly help you apply these after the initial review.
The maintainers of this repo will review your contribution. During a review we will check for:
- Relevance: is this topic interesting? Did we already cover it?
- Writing: any typos? Any flow errors? Is the reading understandable?
- Correctness: are the examples and code correct?
The maintainer reserve the right to not merge your PR if we find it does not meet the standards we like to set for the community. We will work with you, provide feedback and learn together: but we still might not merge.