From 21f40db33dab5b1c84c2c1951b7125882cbed0ca Mon Sep 17 00:00:00 2001 From: tekstrand Date: Mon, 15 Apr 2024 21:07:29 -0500 Subject: [PATCH] First draft of blog contribution guidelines --- docs/about/contributing.mdx | 41 +++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/docs/about/contributing.mdx b/docs/about/contributing.mdx index 5a05a352..200c0bc7 100644 --- a/docs/about/contributing.mdx +++ b/docs/about/contributing.mdx @@ -126,3 +126,44 @@ We're deeply thankful for the backing from the Open Collective, Open Source Coll By covering our hosting costs, Vercel directly contributes to Meshtastic's growth, enhancing our web scalability and presence. Their sponsorship is crucial for our continued development and focus on creating a robust platform for decentralized communication. + +## Contributing to the Meshtastic Blog + +### Purpose + +To share knowledge, updates, and innovations related to Meshtastic helping to enrich, engage, and grow the community. + +### Content Guidelines + +**Acceptable Topics**: Focus on Meshtastic-related themes, such as tutorials, use cases, development updates, and technology deep dives. +**Unacceptable Topics**: Avoid self-promotion or commercial content. Promoting hardware, shops, cases, or other websites is unacceptable. +**Author Biography**: You may link to your personal work or website. Maximum 250 characters. Photos must adhere to the [Meshtastic Conduct](https://meshtastic.org/docs/legal/conduct/) guidelines. + +### Rights and Posting + +**Content Originality**: Posts must be your original work but **can** be published elsewhere. +**Content Rights**: Contributions are under the same CLA as Meshtastic’s other community contributions, aligning with the project’s open-source nature. + +### Submission and Review Process + +**How to Submit**: Articles must be submitted via Pull Requests to the [meshtastic/meshtastic](https://github.com/meshtastic/meshtastic) GitHub Repository. +**Review Process**: Submissions will undergo a review for adherence to content guidelines, quality of information, and relevance to the community. + +### Frequency of Contributions + +**Posting Limits**: To ensure diversity, contributions are limited to two posts per month. Exceptions are available. + +### Formatting, Tone, and Style + +**Expected Tone**: Contributions should be professional and informational. Aim to maintain high-quality, accessible writing that reflects the collaborative spirit of Meshtastic. + +**Format**: All posts must use [Markdown](https://www.markdownguide.org/getting-started/) for formatting. We **strongly** recommend the following resources for your readers' experience: + - [Writing for accessibility (WCAG)](https://www.w3.org/WAI/tips/writing/) + - Use unique titles. + - Headings should convey meaning and structure. + - Make link text meaningful. + - Alt text for images should be meaningful. + - Keep content clear and concise. + - Compress and optimize all images using a tool like [Tinify/TinyPng](https://tinypng.com/). + +**Length**: A good minimum length for your post largely depends on the topic and purpose, but generally, aim for at least 500 to 700 words. Consider condensing your material or splitting it into multiple parts if it approaches 3000 words.