Merge branch 'origin/main' into adlerjohn/remove-changelog

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# How to contribute
+
+## Finding an issue
+
+GitHub issues are used to track the work associated with Optimint. That's where you can find things to work on.
+
+Issue labels have been used to help designate the priority, status and beginner-friendliness of various issues. Here are some of the ones that are most relevant to finding a good issue to work on:
+
+- **Issues available for community contribution:**
+  - `good first issue`: Open to participation from the community and friendly towards new contributors
+
+No explicit permission is needed to work on these issues but it would be good idea to tag the user who opened the issue and ask that the issue is assinged to yourself.
+
+All issue labels can be [found here](https://github.com/celestiaorg/optimint/labels) for you to explore and see what peaks your interest.
+
+## Contribution process
+
+Once you've found an issue you'd like to work on, please follow these steps to make your contribution:
+
+1. Comment on it and say you're working on that issue. This is to avoid conflicts with others also working on the issue.
+2. Write your code and submit your pull request.
+3. Wait for code review and address any issues raised as soon as you can.
+
+**A note on collaboration:** We encourage people to collaborate as much as possible. We especially appreciate contributors reviewing each others pull requests, as long as you are kind and constructive when you do so.
+
+## Proposing a new issue
+
+If you want to work on something that there is no GitHub issue for, follow these steps:
+
+1. Create a a new GitHub issue and propose your change there. Be sure to include implementation details and the rationale for the proposed change.
+   - We are very reluctant to accept random pull requests without a related issue created first.
+2. Wait for a project maintainer to evaluate your issue and decide whether it's something that we will accept a pull request for.
+3. Once the project maintainer has approved the issue, you may start work on code as described in the "Contribution process" section above.

README.md

@@ -1,4 +1,5 @@
 # optimint
+
 ABCI-client implementation for Optimistic Rollups.
 
 Design document: https://docs.google.com/document/d/12gZow_JTJjRrmaD2mNTmYniLhyxVLSyDd7Fbxo5UnA8/edit?usp=sharing
@@ -9,3 +10,14 @@ Design document: https://docs.google.com/document/d/12gZow_JTJjRrmaD2mNTmYniLhyx
 [![codecov](https://codecov.io/gh/celestiaorg/optimint/branch/main/graph/badge.svg?token=CWGA4RLDS9)](https://codecov.io/gh/celestiaorg/optimint)
 [![GoDoc](https://godoc.org/github.com/celestiaorg/optimint?status.svg)](https://godoc.org/github.com/celestiaorg/optimint)
 [![Twitter Follow](https://img.shields.io/twitter/follow/CelestiaOrg?style=social)](https://twitter.com/CelestiaOrg)
+
+## Contributing
+
+We welcome your contributions! Everyone is welcome to contribute, whether it's in the form of code,
+documentation, bug reports, feature requests, or anything else.
+
+If you're looking for issues to work on, try looking at the [good first issue list](https://github.com/celestiaorg/optimint/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). Issues with this tag are suitable for a new external contributor and is a great way to find something you can help with!
+
+See [the contributing guide](./CONTRIBUTING.md) for more details.
+
+Please join our [Community Discord](https://discord.com/invite/YsnTPcSfWQ) to ask questions, discuss your ideas, and connect with other contributors.