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

Add contributing guidelines #841

Merged
merged 4 commits into from Nov 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions .prettierrc.json
@@ -0,0 +1,10 @@
{
"overrides": [
{
"files": "*.md",
"options": {
"proseWrap": "always"
}
}
]
}
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,11 @@
# Contributing Guidelines
uint marked this conversation as resolved.
Show resolved Hide resolved

We're happily accepting bugfixes, style improvements, good refactors and enhancements to documentation.

For the specs, their APIs are considered final and immutable. We do not accept API-breaking changes.

It is possible to propose a new protocol instead. In that case, please open an issue for discussion first, including
some motivating use cases.

The contracts are not expected to be packed with features. They're expected to be minimal, reference implementations of
the specifications. We do not therefore accept enhancements.