Updated contributor guide
Minor typo fixes
Added references to the detailed contributor guide in the docs.
## Thanks for looking into contributing to Weaviate!
-We really appreciate that you are willing to spend some time and effort to make Weaviate better for everyone! This guide is designed to make it as easy as possible for everyone involved.
+We really appreciate that you are willing to spend some time and effort to make Weaviate better for everyone!
+
+We have a detailed [contributor guide](https://weaviate.io/developers/contributor-guide/current/) as a part of our documentation. If you are new, we recommend reading through the [getting started guide for contributors](https://weaviate.io/developers/contributor-guide/current/getting-started/index.html) after reading this overview.
## Finding a good issue to get started
We use the `good-first-issue` labels on issues that we think are great to get started. Typically, they are issues that are isolated to a specific area of Weaviate, e.g. only the API layer or only a specific package.
## What do you need to contribute
-To contribute to Weaviate Core you should have at least basic Golang skills. It is also tremendously helpful if you have succesfully used Weaviate before, so that you have a rough understand of the effects of changes etc. Any PR must include tests. We understand that not everyone is very familiar with testing strategies, and how we have setup our tests. This [guide on testing](https://weaviate.io/developers/contributor-guide/current/weaviate-core/tests.html) should be a great start. If you have completed a change, but are struggling with the test, you can also open a Draft PR and ask someone from our team for help.
+To contribute to Weaviate Core you should have at least basic Golang skills. It is also tremendously helpful if you have successfully used Weaviate before, so that you have a rough understand of the effects of changes etc. Any PR must include tests. We understand that not everyone is very familiar with testing strategies, and how we have setup our tests. This [guide on testing](https://weaviate.io/developers/contributor-guide/current/weaviate-core/tests.html) should be a great start. If you have completed a change, but are struggling with the test, you can also open a Draft PR and ask someone from our team for help.
## If in doubt, ask.
-The Weaviate team consists of some of the nicest people on this planet. If something is unclear or you'd like a second opinion, please don't hesistate to ask. We are glad that you want to help us, so naturally we will also do our best to help you on this journey
+The Weaviate team consists of some of the nicest people on this planet. If something is unclear or you'd like a second opinion, please don't hesitate to ask. We are glad that you want to help us, so naturally we will also do our best to help you on this journey
## Development Environment
-*Please note that the Weaviate team uses Linux and Mac (darwin) machines exclusively. Development on Windows may lead to unexpected issues.*
+*Please note that the Weaviate team uses Linux and Mac (darwin/arm64) machines exclusively. Development on Windows may lead to unexpected issues.*
Here are some guides to get started in no time:
* [Development Setup](https://weaviate.io/developers/contributor-guide/current/weaviate-core/setup.html)
@@ -19,7 +21,6 @@ Here are some guides to get started in no time:
* [CI/CD](https://weaviate.io/developers/contributor-guide/current/weaviate-core/cicd.html)
* [Testing Philopshopy](https://weaviate.io/developers/contributor-guide/current/weaviate-core/tests.html)
-
## Tagging your commit
Please tag your commit(s) with the appropriate GH issue that your change refers to, e.g. `gh-9001 reduce memory allocations of ACME widget`. Please also include something in your PR description to indicate which issue it will close, e.g. `fixes #9001` or `closes #9001`.
