AISocietyIITJ / AISocietyIITJ/blogs-raid

Make CONTRIBUTING.md more descriptive

未关闭
#15 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation good first issue
主要语言
Astro
星标
4
派生
11
PR 合并指标
30 天内没有已合并 PR

描述

Because of current version of CONTRIBUTING.md we are facing these problem:-

1. Missing Frontmatter: Contributors frequently forget to add the **frontmatter** to their blog posts, causing metadata issues.
2. Incorrect Image Handling: Instead of linking to images in the public folder, contributors often **copy and paste** images directly into the Markdown files. This unnecessarily increases the repository size and bypasses our image optimization process.
3. Inconsistent Writing Style: Blog posts sometimes lack a clear narrative **_flow_**. They often use excessive abbreviations without defining them first, which can confuse readers.
4. Lack of Guidance on Formulas: There is no clear recommendation for contributors to use the **.mdx format** when they need to include mathematical formulas, despite our support for LaTeX in MDX.

### **Task**

Update Contribution Guidelines (CONTRIBUTING.md)

- [ ] Add a mandatory checklist to the Pull Request template that requires contributors to confirm they have added the correct frontmatter.
- [ ] Create a clear section on how to handle images:
- Explain that all images must be placed in the /public/ directory.
- Provide a clear example of the correct Markdown syntax for linking images.
- Explicitly forbid embedding images directly into .md or .mdx files.
- [ ] Enhance the writing style guide:
- Emphasize the importance of storytelling and maintaining a logical flow.
- [ ] Add documentation for writing mathematical formulas:
- State that posts containing LaTeX formulas must use the .mdx file extension.
- [ ] Create a Blog Post Template
- Design a template file (template.mdx) that includes placeholder frontmatter and commented-out instructions for each section, including image and formula usage. This can serve as a starting point for new contributions.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。