Skip to content
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

feat: add notable contribution template #22

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/NOTABLE-CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should use PRs only for notable contributions and discussions about their relevance.

A notable contribution should consist of a clear and concise commit title, ideally a single explicit line. Sometimes, it may need to include several links, but the main description should be in the actual contributions, such as the PR in the monorepo. A notable contribution entry here should not be the place where we spend too much time explaining why we believe it is significant.

If we want discussions, they can occur on the PR discussion page.

name: Notable Contribution Template
about: Endorse yourself or someone else for a notable contribution to the project
---

## Description
Thank you for your interest in contributing to the gno.land project and joining the [Game of Realms](https://github.com/gnolang/game-of-realms/)! This template will guide you in documenting your contributions to our ecosystem. Fill out as much

## Contributor Details
- **GitHub Username**: `[Your GitHub Username]`
- **Preferred Contact (optional)**: `[Signal/Discord/Telegram]`
- **Brief Bio**: `[Tell us a little about yourself, your skills, and why you're interested in contributing to gno.land]`

---

## Contribution Summary
- **Contribution Title**: `[Title of your Contribution]`
- **Date(s) of Contribution**: `[e.g., Jan 2024 - Present]`
- **Type of Contribution**: `[Choose one: Code, Documentation, Tools, Community Engagement, or Other]`

---

## Contribution Description

### Overview
Describe the goal of your contribution and how it aligns with the goals of gno.land.
`[Write a brief overview here]`

### Key Changes & Impact
Provide a summary of the key code changes or efforts, and their expected impact on the project or the community.
- `[Key change 1 and its impact]`
- `[Key change 2 and its impact]`
- `[Additional changes and impacts]`

### Challenges & Solutions
Outline any challenges encountered and how you addressed them.
- `[Challenge 1 and solution]`
- `[Challenge 2 and solution]`

---

## Pull Requests Linked to This Contribution
Please list any pull requests related to this contribution.
- PR #[Link/Title]
- PR #[Link/Title]

---

## Additional Notes
Include any additional information or context about your contribution.
- `[Additional notes or relevant links]`

---

## Future Plans
If you plan to continue contributing, outline any upcoming ideas or goals here.
- `[Future idea or goal]`
- `[Future idea or goal]`

---

Thank you for being part of the gno.land journey! Contributions to this issue will be evaluated for inclusion in our Notable Contribution folder and may help shape the future of gno.land and web3.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/SIMPLE-ISSUE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's the advantage of having such template?

name: Simple Issue Template
about: Create a simple issue with a description
---

## Description
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false