From dac1d8f7838a08b84ad160180ea7e4ab95fcf1e8 Mon Sep 17 00:00:00 2001 From: Ben McCallum Date: Fri, 3 Sep 2021 00:36:06 +0200 Subject: [PATCH] Improve onboarding experience for new contributors (#4174) --- CONTRIBUTING.md | 11 +++++++++++ README.md | 4 ++++ 2 files changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f2e73e9c44..406dfd2dc0b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,6 +32,8 @@ Before you spend time writing code, make sure of the following things: After this you can fork our repository to implement your changes. If you are unfamiliar with forking, be sure to read [this guide](https://guides.github.com/activities/forking/) first. +To get started with the codebase, see [How to launch and build the solution](#how-to-launch-and-build-the-solution). + ### Before submitting a pull request Before submitting a pull request containing your changes, make sure that it checks the following requirements: @@ -56,6 +58,15 @@ Follow [this guide](https://docs.github.com/en/github/collaborating-with-issues- Core contributors will review your pull request and provide feedback. +## How to launch and build the solution + +We use [Nuke](https://nuke.build/) for build automation. It can be used to bootstrap you a complete solution file. +Simply run build.ps1, build.sh or build.cmd and then in the src directory you can open up All.sln. + +There are other available commands too. As setup in the [.build](./.build/) directory. + +Other more focused solution files exist if you want to narrow in on a particular part of the platform. + ## Code of conduct See [CODE-OF-CONDUCT.md](./CODE-OF-CONDUCT.md) diff --git a/README.md b/README.md index a6ca3246b68..ecd16d1ec44 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,10 @@ Examples of things built on top of the ChilliCream GraphQL Platform that are ope - [GraphQL workshop](https://github.com/ChilliCream/graphql-workshop) - [HotChocolate examples](https://github.com/ChilliCream/hotchocolate-examples) +## Contributing + +[Become a code contributor](CONTRIBUTING.md) and help us make the ChilliCream GraphQL platform even better! + ## From our community [Check out](COMMUNITY.md) what members of our awesome community have made!