@@ -6,9 +6,9 @@ This contributing guide is based on the contributing for Elixir with changes sui
66
77Use the issues tracker for:
88
9- * [ bug reports] ( #bug-reports )
10- * [ submitting pull requests] ( #pull-requests )
11- * [ feature requests] ( #feature-requests )
9+ - [ bug reports] ( #bug-reports )
10+ - [ submitting pull requests] ( #pull-requests )
11+ - [ feature requests] ( #feature-requests )
1212
1313## Bug reports
1414
@@ -51,7 +51,7 @@ Example:
5151## Feature requests
5252
5353Feature requests are welcome. But take a moment to find
54- out whether your idea fits with the scope and aims of the project. It's up to * you *
54+ out whether your idea fits with the scope and aims of the project. It's up to _ you _
5555to make a strong case to convince the community of the merits of this feature.
5656Please provide as much detail and context as possible.
5757
@@ -63,18 +63,18 @@ found in Elixir in ElixirScript.
6363
6464ElixirScript is broken up into the following parts:
6565
66- * The compiler, written in Elixir
67- * The JavaScript core
66+ - The compiler, written in Elixir
67+ - The JavaScript core
6868
69- The ElixirScript compiler is in the ` lib ` folder of the project.
69+ The ElixirScript compiler is in the ` lib ` folder of the project.
7070Here is where Elixir code is converted into JavaScript.
7171
72- The JavaScript code is in the ` src/javascript ` .
72+ The JavaScript code is in the ` src/javascript ` .
7373This is where the special forms and the Erlang Compatibility Layer are defined
7474
75- The ElixirScript tests can be run using ` mix test `
75+ The ElixirScript tests are ran using ` mix test `
7676
77- The JavaScript tests can be run using ` yarn test`
77+ The JavaScript tests are ran using ` npm test`
7878
7979Please make sure all tests pass after making changes. Also make sure to include tests for
8080the changes you made.
@@ -104,72 +104,72 @@ documentation. When working with Git, we recommend the following process
104104in order to craft an excellent pull request:
105105
1061061 . [ Fork] ( https://help.github.com/fork-a-repo/ ) the project, clone your fork,
107- and configure the remotes:
107+ and configure the remotes:
108108
109- ``` sh
110- # Clone your fork of the repo into the current directory
111- git clone https://github.com/< your-username> /elixirscript
112- # Navigate to the newly cloned directory
113- cd elixirscript
114- # Assign the original repo to a remote called "upstream"
115- git remote add upstream https://github.com/elixirscript/elixirscript
116- ```
109+ ``` sh
110+ # Clone your fork of the repo into the current directory
111+ git clone https://github.com/< your-username> /elixirscript
112+ # Navigate to the newly cloned directory
113+ cd elixirscript
114+ # Assign the original repo to a remote called "upstream"
115+ git remote add upstream https://github.com/elixirscript/elixirscript
116+ ```
117117
1181182 . If you cloned a while ago, get the latest changes from upstream:
119119
120- ``` sh
121- git checkout master
122- git pull upstream master
123- ```
120+ ``` sh
121+ git checkout master
122+ git pull upstream master
123+ ```
124124
1251253 . Create a new topic branch (off of ` master ` ) to contain your feature, change,
126- or fix.
126+ or fix.
127127
128- ** IMPORTANT** : Making changes in ` master ` is discouraged. You should always
129- keep your local ` master ` in sync with upstream ` master ` and make your
130- changes in topic branches.
128+ ** IMPORTANT** : Making changes in ` master ` is discouraged. You should always
129+ keep your local ` master ` in sync with upstream ` master ` and make your
130+ changes in topic branches.
131131
132- ``` sh
133- git checkout -b < topic-branch-name>
134- ```
132+ ``` sh
133+ git checkout -b < topic-branch-name>
134+ ```
135135
1361364 . Commit your changes in logical chunks. Keep your commit messages organized,
137- with a short description in the first line and more detailed information on
138- the following lines. Feel free to use Git's
139- [ interactive rebase] ( https://help.github.com/articles/interactive-rebase )
140- feature to tidy up your commits before making them public.
137+ with a short description in the first line and more detailed information on
138+ the following lines. Feel free to use Git's
139+ [ interactive rebase] ( https://help.github.com/articles/interactive-rebase )
140+ feature to tidy up your commits before making them public.
141141
1421425 . Make sure all the tests are still passing.
143143
144- ``` sh
145- mix test
146- yarn test
147- ```
144+ ``` sh
145+ mix test
146+ npm test
147+ ```
148148
149- This is needed to ensure your changes can
150- pass all the tests.
149+ This is needed to ensure your changes can
150+ pass all the tests.
151151
1521526 . Push your topic branch up to your fork:
153153
154- ``` sh
155- git push origin < topic-branch-name>
156- ```
154+ ``` sh
155+ git push origin < topic-branch-name>
156+ ```
157157
1581587 . [ Open a Pull Request] ( https://help.github.com/articles/using-pull-requests/ )
159- with a clear title and description.
159+ with a clear title and description.
160160
1611618 . If you haven't updated your pull request for a while, you should consider
162- rebasing on master and resolving any conflicts.
163-
164- ** IMPORTANT** : _ Never ever_ merge upstream ` master ` into your branches. You
165- should always ` git rebase ` on ` master ` to bring your changes up to date when
166- necessary.
167-
168- ``` sh
169- git checkout master
170- git pull upstream master
171- git checkout < your-topic-branch>
172- git rebase master
173- ```
162+ rebasing on master and resolving any conflicts.
163+
164+ ** IMPORTANT** : _ Never ever_ merge upstream ` master ` into your branches. You
165+ should always ` git rebase ` on ` master ` to bring your changes up to date when
166+ necessary.
167+
168+ ``` sh
169+ git checkout master
170+ git pull upstream master
171+ git checkout < your-topic-branch>
172+ git rebase master
173+ ```
174174
175175Thank you for your contributions!
0 commit comments