diff options
| author | José Valim <jose.valim@gmail.com> | 2016-09-21 14:33:08 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-21 14:33:08 +0200 |
| commit | 316eb2d28751479d84b374d3cf3d90d68728bc91 (patch) | |
| tree | 2023c3699d63ea4def8fedcf9dc1d078dc27e4b1 | |
| parent | dd78780363bba0fa33d95375ef9eb55a9014471f (diff) | |
| download | elixir-316eb2d28751479d84b374d3cf3d90d68728bc91.tar.gz | |
Update README.md
| -rw-r--r-- | README.md | 22 |
1 files changed, 18 insertions, 4 deletions
@@ -24,9 +24,8 @@ If Elixir fails to build (specifically when pulling in a new version via `git`), be sure to remove any previous build artifacts by running `make clean`, then `make test`. -If tests pass, you are ready to move on to the -[Getting Started guide][1] or to try Interactive Elixir by running: -`bin/iex` in your terminal. +If tests pass, you are ready to move on to the [Getting Started guide][1] +or to try Interactive Elixir by running `bin/iex` in your terminal. However, if tests fail, it is likely you have an outdated Erlang version (Elixir requires Erlang 18.0 or later). You can check your Erlang version @@ -39,7 +38,9 @@ you may want to open up a bug report, as explained next. ## Bug reports -For reporting bugs, [visit our issues tracker][2] and follow the steps for reporting a new issue. Security vulnerabilities must be privately disclosed at elixir-security@googlegroups.com. +For reporting bugs, [visit our issues tracker][2] and follow the steps +for reporting a new issue. Please disclose security vulnerabilities +privately at elixir-security@googlegroups.com. ## Contributing @@ -95,6 +96,19 @@ to argue and explain why a feature is useful and how it will impact the codebase and the community. Finally, remember all interactions in our official spaces follow our [Code of Conduct][7]. +### Reviewing changes + +Once a pull request is sent, the Elixir team will review your changes. +We outline our process below to clarify the roles of everyone involved. + +All pull requests must be approved by two comitters before merged into +the repository. In case any changes are necessary before merging, the +team will leave appropriate comments requesting changes to the code. + +The Elixir team may optionally assign someone to review a pull request. +In case someone is assigned, they must explicitly approve the code before +another team member can merge it. + ## Building documentation Building the documentation requires [ExDoc](https://github.com/elixir-lang/ex_doc) |