Skip to content

Commit 23b0c8c

Browse files
author
José Valim
committed
Improve contributing guide
1 parent eb7c541 commit 23b0c8c

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,15 @@ Guidelines for bug reports:
3434
reported.
3535

3636
2. **Check if the issue has been fixed** — try to reproduce it using the
37-
latest `master` or development branch in the repository.
37+
`master` branch in the repository.
3838

39-
3. **Isolate the problem** — ideally create a reduced test
39+
3. **Isolate and report the problem** — ideally create a reduced test
4040
case.
4141

42-
A good bug report shouldn't leave others needing to chase you up for more
43-
information. Please try to be as detailed as possible in your report. What is
44-
your environment? What steps will reproduce the issue? What version of Erlang
45-
and Elixir experience the problem? What would you expect to be the outcome?
46-
All these details will help people to fix any potential bugs.
42+
Please try to be as detailed as possible in your report. Include information about
43+
your Operating System, your Erlang and Elixir versions. Please provide steps to
44+
reproduce the issue as well as the outcome you were expecting! All these details
45+
will help developers to fix any potential bugs.
4746

4847
Example:
4948

@@ -67,8 +66,8 @@ Example:
6766

6867
Feature requests are welcome and should be discussed on [the elixir-core mailing list](http://groups.google.com/group/elixir-lang-core). But take a moment to find
6968
out whether your idea fits with the scope and aims of the project. It's up to *you*
70-
to make a strong case to convince the project's developers of the merits of this
71-
feature. Please provide as much detail and context as possible.
69+
to make a strong case to convince the community of the merits of this feature.
70+
Please provide as much detail and context as possible.
7271

7372
## Contributing
7473

@@ -91,6 +90,16 @@ You can run all tests in the root directory with `make test` and you can
9190
also run tests for a specific framework `make test_#{NAME}`, for example,
9291
`make test_ex_unit`.
9392

93+
In case you are changing a single file, you can compile and run tests only
94+
for that particular file for fast development cycles. For example, if you
95+
are changing the String module, you can compile it and run its tests as:
96+
97+
$ bin/elixirc lib/elixir/lib/string.ex -o lib/elixir/ebin
98+
$ bin/elixir lib/elixir/test/elixir/string_test.exs
99+
100+
After your changes are done, please remember to run the full suite with
101+
`make test`.
102+
94103
From time to time, your tests may fail in an existing Elixir checkout and
95104
may require a clean start by running `make clean compile`. You can always
96105
check [the official build status on Travis-CI](https://travis-ci.org/elixir-lang/elixir).
@@ -108,14 +117,14 @@ something like:
108117

109118
```elixir
110119
@doc """
111-
Return only those elements for which `fun` is true.
120+
Returns only those elements for which `fun` is true.
112121
113122
...
114123
"""
115124
def filter(collection, fun) ...
116125
```
117126

118-
For modules, records, protocols and types say what it is. For example write
127+
For modules, protocols and types say what it is. For example write
119128
something like:
120129

121130
```elixir
@@ -167,10 +176,10 @@ commits.
167176
**IMPORTANT**: By submitting a patch, you agree that your work will be
168177
licensed under the license used by the project.
169178

170-
If you have any significant pull request in mind (e.g. implementing features,
171-
refactoring code, porting to a different language), **please ask first**
172-
otherwise you risk spending a lot of time working on something that the
173-
project's developers might not want to merge into the project.
179+
If you have any large pull request in mind (e.g. implementing features,
180+
refactoring code, etc), **please ask first** otherwise you risk spending
181+
a lot of time working on something that the project's developers might
182+
not want to merge into the project.
174183
175184
Please adhere to the coding conventions in the project (indentation,
176185
accurate comments, etc.) and don't forget to add your own tests and

0 commit comments

Comments
 (0)