diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7da790d3..9355e54a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,9 +1,4 @@ -### Contributor checklist +# Contributor checklist -- [ ] My commit messages follow the [Conventional Commit Message Format](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message) - For example: `fix: Multiply by appropriate coefficient`, or - `feat(Calculator): Correctly preserve history` - Any explanation or long form information in your commit message should be - in a separate paragraph, separated by a blank line from the primary message - [ ] Bug fixes include regression tests - [ ] Features include unit/acceptance tests diff --git a/documentation/introduction/getting_started.md b/documentation/introduction/getting_started.md index fc57a629..a8004d56 100644 --- a/documentation/introduction/getting_started.md +++ b/documentation/introduction/getting_started.md @@ -8,6 +8,15 @@ For information on creating a new Elixir application, see [this guide](https://e Add `ash` to your dependencies in `mix.exs`. The latest version can be found by running `mix hex.info ash`. +```elixir +# in mix.exs +def deps() do + [ + {:ash, "~> x.x.x"} + ] +end +``` + ## Create an Ash API Create an API module. This will be your primary way to interact with your Ash resources. We recommend `lib/my_app/api.ex` for simple setups. For more information on organizing resources into contexts/domains, see the "Contexts and Domains" guide.