Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 3.75 KB
Raw

Contributing to the Gno Blog

Thank you for considering a contribution to the gno.land blog. We appreciate all and every open-source contribution to the gno.land project, as everything we do revolves around open-source. Below, you will find guidelines on how to submit a blog post to the gno.land blog.

If you are unsure about something, please don’t hesitate to reach out for help by opening an issue here, on Discord, or directly to the gno.land DevRel team. Likewise, if you have an idea on how to improve this guide, go for it as well.

What we are looking for

We’re seeking contributions that will bring value to our growing community of gnomes. If you can bring technical expertise or a different perspective to the table, we want to hear from you. Please ensure your article is written in high-quality text and formatted according to the specifications below. We don’t tolerate plagiarism, excessive self-promotion, link spamming, SEO stuffing, or hate speech.

Below are topics of particular interest to us, but we’re open to all suggestions, so if you have an idea that’s not on the list, but you believe will make great reading, feel free to submit your story.

  • Web3 news and developments and how they impact our community (e.g. legislation, industry trends, technical advances)
  • Technical deep dives (e.g. language comparisons, pros and cons, examining the core stack)
  • Useful intros about basic concepts in gno.land (e.g. package/realm distinction)
  • General content that helps explain reasoning or thought processes (e.g. writing the entire stack in Go vs implementing components in Rust)
  • Op-ed pieces and alternative views (e.g. building effective governance, decentralizing social media, the importance of censorship-resistant tools)

Contribution process

If you've considered the previous section and would like to contribute to the gno.land blog, here are the steps to follow:

  • Write a blog post you'd like to see included to the Gno Blog, while strictly following the Style Guide.
  • Submit a PR using this template, while following the structure of the folders & naming, as shown in the example blog post.
  • Ping the gno.land DevRel team, @leohhhn and @michelleellen for a review.

After your blog post passes the review process, it will be merged into the main branch and shortly after deployed on-chain.

Gno.land Blog Style Guide

This style guide offers rules and preferences for contributing to the Gno Blog. Below are some rules to follow when writing a blog post.

  1. All Gno Blog posts are written in standard Markdown. Follow the formatting for headers, links, bold, italic, strikethrough, etc. as you usually would.
  2. Check your content for spelling and grammatical mistakes before submitting.
  3. Use the Oxford comma.
  4. Make sure the target reader is addressed consistently.
  5. Make sure the product, company, tech, and other names are accurate.
  6. Fact-check your content.
  7. If your post contains images, please add a src folder to contain them, and link to them in Markdown.
  8. Include front-matter in your blog post, detailing the following:
    1. Title
    2. Publication date
    3. Slug
    4. Tags
    5. Authors

Tags

Tags, or hashtags, should be lowercase and without spaces; eg, #foobar NOT #FooBar.

If you're unsure of how to style or format something, take a look at the example blog post PR or review the other blog posts in this repo for inspiration; as a last resort, message @leohhhn or @michelleellen for help within your PR or issue thread.