Skip to content

Commit

Permalink
Adding contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
sbvegan committed Apr 29, 2024
1 parent d119b4e commit e76b91f
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to the OP Stack Specifications

## Using GitHub Discussions

We encourage you to utilize the [GitHub Discussions section](https://github.com/ethereum-optimism/specs/discussions) for engaging with the core developers. Here’s how you can make the most of it:

### Questions about the Current Specification

- If you have questions or need clarifications regarding the current specifications, please start a discussion under the [Q&A category](https://github.com/ethereum-optimism/specs/discussions/categories/q-a).
- This is the place to ask detailed questions about how things work today and to understand the existing specs better.

### Discussing Experimental Features Under Development

- For experimental features that are currently in development, use the [general category](https://github.com/ethereum-optimism/specs/discussions/categories/general) to ask questions, seek clarifications, or offer suggestions.
- This is a collaborative space to discuss ongoing developments and how they could impact the future of Ethereum Optimism.
- Engage directly with core developers working on these features and contribute to shaping their progress.

### Proposing New Experimental Features

- Interested in proposing new features or experimental ideas? Start a discussion to gather feedback and input from the community.
- Outline your proposal clearly, providing enough context and reasoning to facilitate productive discussions.
- Engage with feedback to refine your proposal based on community input.

Using Discussions is a fantastic way to connect with other contributors, understand the breadth and depth of ongoing work, and make your contributions more impactful. We look forward to your questions, ideas, and discussions!

Thank you for contributing to the OP Stack!
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Please chat with us on the [discussion board](https://github.com/ethereum-optimi

## Contributing

We welcome your contributions.
We welcome your contributions. Read through [CONTRIBUTING.md](./CONTRIBUTING.md) for a general overview of the contributing process for this repository.

### Dependencies

Expand Down

0 comments on commit e76b91f

Please sign in to comment.