Update README and provide CONTRIBUTING.md (#11)

* first pass * update contributing doc * update the readme to reflect the android repo * update information for pre preview * Update README.md * remove unsupported sections for now * refinements to contributing.md * retrigger CI --------- Co-authored-by: Naomi Plasterer <[email protected]> Co-authored-by: Naomi Plasterer <[email protected]>
xmtp · Feb 23, 2023 · b26d97b · b26d97b
1 parent 6435c6b
commit b26d97b
Show file tree

Hide file tree

Showing 2 changed files with 385 additions and 6 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,31 @@
+# Contributing
+
+Thank you for considering contributing to this repo. Community contributions like yours are key to the development and adoption of XMTP. Your questions, feedback, suggestions, and code contributions are welcome.
+
+## ❔ Questions
+
+Have a question about how to build with XMTP? Ask your question and learn with the community in the [Q&A discussion forum](https://github.com/orgs/xmtp/discussions/categories/q-a).
+
+## 🐞 Bugs
+
+Report bugs as [GitHub Issues](https://github.com/xmtp/xmtp-android/issues/new?assignees=&labels=bug&template=bug_report.yml&title=Bug%3A+). Please confirm that there isn't an existing open issue about the bug and include detailed steps to reproduce the bug.
+
+## ✨ Feature requests
+
+Submit feature requests as [GitHub Issues](https://github.com/xmtp/xmtp-android/issues/new?assignees=&labels=enhancement&template=feature_request.yml&title=Feature+request%3A+). Please confirm that there isn't an existing open issue requesting the feature. Describe the use cases this feature unlocks so the issue can be investigated and prioritized.
+
+## 🔀 Pull requests
+
+PRs are encouraged, but consider starting with a feature request to temperature-check first. If the PR involves a major change to the protocol, the work should be fleshed out as an [XMTP Improvement Proposal](https://github.com/xmtp/XIPs/blob/main/XIPs/xip-0-purpose-process.md) before work begins.
+
+## 🔧 Developing
+
+### Prerequisites
+
+#### Docker
+
+Please make sure you have Docker running locally. Once you do, you can run the following command to start a local test server:
+
+```sh
+script/local
+```