-
Notifications
You must be signed in to change notification settings - Fork 9
feat: add contribution guidelines #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 15 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
5e9b13f
remove test blog post
waymobetta e79f3fb
fix bold syntax
waymobetta 655cb91
fix spacing
waymobetta 8837c01
Update posts/2023-09-29_gnomobile/README.md
waymobetta dc9ef94
Update posts/2023-09-29_gnomobile/README.md
waymobetta 2652e93
Update posts/2023-09-29_gnomobile/README.md
waymobetta b6f3edc
update deprecated package
waymobetta 650ea53
fix: add proper tag formatting
waymobetta 6fae19f
WIP add contributions.md & style guide
leohhhn 7c574fa
updated structure & contributing.md
leohhhn a1aeb82
add details
leohhhn 44660a6
remove wrong detail
leohhhn 7f62a46
add template PR link
leohhhn f523db4
added contributing to README
leohhhn f051d80
feat: add tags section, links + cleanup
waymobetta 680abef
fix: add profile links
waymobetta ca2ef36
Merge branch 'main' into feat/add-contribution-guidelines
moul File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,5 @@ | ||
reporting/reporting | ||
reporting/output | ||
.idea | ||
posts/.DS_Store | ||
.DS_Store |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing to the Gno Blog | ||
|
||
Thank you for considering a contribution to the Gno 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 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) | ||
- Gno ecosystem news (e.g. interesting new realms/apps, newly-added core functionality, etc.) | ||
- Technical deep dives (e.g. language comparisons, pros and cons, examining the core stack) | ||
- Tutorials and how-to guides | ||
- 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 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](#gno-blog-style-guide). | ||
- Submit a PR using [this template](https://github.com/gnolang/blog/pull/35), while following the structure of the folders & naming, as shown in the example blog post. | ||
- Ping the Gno.land DevRel team, @waymobetta & @leohhhn 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 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](#tags) | ||
5. Authors | ||
|
||
#### Tags | ||
Tags, or [hashtags](https://en.wikipedia.org/wiki/Hashtag), 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](https://github.com/gnolang/blog/pull/35) or review the other [blog posts in this repo](posts) for inspiration; as a last resort, message [@waymobetta](https://github.com/waymobetta) or [@leohhhn](https://github.com/leohhhn) for help within your PR or issue thread. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Already managed by the next line.