Skip to content

Create contributing guide #323

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

Open
wants to merge 5 commits 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
49 changes: 0 additions & 49 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml

This file was deleted.

66 changes: 0 additions & 66 deletions .github/ISSUE_TEMPLATE/02-feature-request.yml

This file was deleted.

18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/03-docs-request.yml

This file was deleted.

31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/04-epic-template.md

This file was deleted.

24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/05-issue-template.md

This file was deleted.

51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/issue-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
name: Issue
about: Report a bug or request a feature
title: "[Bug] <summary>" or "[Feature] <summary>"
labels: needs-triage
assignees: ''
---

## Type

<!-- Please check one -->
- [ ] Bug
- [ ] Feature
- [ ] Proposal / Discussion

## Summary

<!--
Describe the issue or request in 1–2 sentences.
Include relevant context or background.
-->

## Reproduction (for bugs)

<!--
Include minimal steps to reproduce the bug. Example:

1. Run `make start`
2. Submit a tx via `evm.send()`
3. Observe panic in logs
-->

## Impact

<!--
Explain the potential severity and who is affected.
E.g., critical bug for validators, minor UX issue, etc.
-->

## Related

<!--
Link related issues or PRs.
-->

## Checklist

- [ ] Linked to a GitHub Issue (or this is the Issue)
- [ ] Repro steps included (for bugs)
- [ ] Impact described
- [ ] I understand minor typo/style doc fixes will not be accepted
16 changes: 0 additions & 16 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,3 @@ I have...
- [ ] tackled an existing issue or discussed with a team member
- [ ] left instructions on how to review the changes
- [ ] targeted the `main` branch

## Reviewers Checklist

**All** items are required.
Please add a note if the item is not applicable
and please add your handle next to the items reviewed
if you only reviewed selected items.

I have...

- [ ] added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
- [ ] confirmed all author checklist items have been addressed
- [ ] confirmed that this PR does not change production code
- [ ] reviewed content
- [ ] tested instructions (if applicable)
- [ ] confirmed all CI checks have passed
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing to Cosmos EVM

We appreciate community contributions! To ensure a smooth process, please follow these guidelines.

---

## Requirements for Pull Requests

1. **Issue Link Required**
- All pull requests must be linked to an existing [GitHub Issue](https://github.com/cosmos/evm/issues).
- PRs without a corresponding issue **will not be reviewed**.
- Issues should include:
- **Reproducibility**: If the issue is a bug, describe steps to reproduce the problem clearly.
- **Context & Explanation**: Provide enough background so others can understand the problem or motivation.
- **Potential Impact**: Explain how this affects the project or user experience (e.g., severity, user scope, downstream effects).

2. **Signed Commits**
- All commits must be [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
- Unsigned commits will be rejected.

3. **Documentation Contributions**
- We only accept documentation PRs that make **substantial or impactful changes**.
- Minor typo or style-only fixes in documentation will not be accepted.

---

## Getting Started

- Fork the repo and create your branch from `main`.
- Run tests and linters before submitting.
- Make sure your code adheres to the project's style and conventions.

---

Thank you for helping improve Cosmos EVM!
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,10 @@ make test-solidity
make benchmark
```

## Contributing

We welcome open source contributions and discussions! For more on contributing, read our [guide](./CONTRIBUTING.md).

## Open-source License & Credits

Cosmos EVM is open-source under the Apache 2.0 license, an extension of the license of the original codebase (https://github.com/evmos/OS)
Expand Down
Loading