Skip to content

Commit

Permalink
Improve onboarding experience for new contributors (ChilliCream#4174)
Browse files Browse the repository at this point in the history
  • Loading branch information
benmccallum authored Sep 2, 2021
1 parent b9f2509 commit dac1d8f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down

0 comments on commit dac1d8f

Please sign in to comment.