You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -190,7 +190,7 @@ The Julia community uses [GitHub issues](https://github.com/JuliaLang/julia/issu
190
190
Issues and pull requests should have self explanatory titles such that they can be understood from the list of PRs and Issues.
191
191
i.e. `Add {feature}` and `Fix {bug}` are good, `Fix #12345. Corrects the bug.` is bad.
192
192
193
-
You can make pull requests for incomplete features to get code review. The convention is to open these a draft PRs and prefix
193
+
You can make pull requests for incomplete features to get code review. The convention is to open these as draft PRs and prefix
194
194
the pull request title with "WIP:" for Work In Progress, or "RFC:" for Request for Comments when work is completed and ready
195
195
for merging. This will prevent accidental merging of work that is in progress.
196
196
@@ -209,6 +209,7 @@ Add new code to Julia's base libraries as follows (this is the "basic" approach;
209
209
Build as usual, and do `make clean testall` to test your contribution. If your contribution includes changes to Makefiles or external dependencies, make sure you can build Julia from a clean tree using `git clean -fdx` or equivalent (be careful – this command will delete any files lying around that aren't checked into git).
210
210
211
211
#### Running specific tests
212
+
212
213
There are `make` targets for running specific tests:
213
214
214
215
make test-bitarray
@@ -346,8 +347,8 @@ please remove the `backport-X.Y` tag from the originating pull request for the c
346
347
347
348
### Git Recommendations For Pull Requests
348
349
349
-
- Avoid working from the `master` branch of your fork, creating a new branch will make it easier if Julia's `master` changes and you need to update your pull request.
350
-
- Try to [squash](https://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) together small commits that make repeated changes to the same section of code so your pull request is easier to review. A reasonable number of separate well-factored commits is fine, especially for larger changes.
350
+
- Avoid working from the `master` branch of your fork. Create a new branch as it will make it easier to update your pull request if Julia's `master` changes.
351
+
- Try to [squash](https://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) together small commits that make repeated changes to the same section of code, so your pull request is easier to review. A reasonable number of separate well-factored commits is fine, especially for larger changes.
351
352
- If any conflicts arise due to changes in Julia's `master`, prefer updating your pull request branch with `git rebase` versus `git merge` or `git pull`, since the latter will introduce merge commits that clutter the git history with noise that makes your changes more difficult to review.
352
353
- Descriptive commit messages are good.
353
354
- Using `git add -p` or `git add -i` can be useful to avoid accidentally committing unrelated changes.
Copy file name to clipboardExpand all lines: doc/src/devdocs/build/build.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,19 +39,26 @@ directory mirror, with all of the necessary Makefiles to build Julia,
39
39
in the specified directory. These builds will share the source files
40
40
in Julia and `deps/srccache`. Each out-of-tree build directory can
41
41
have its own `Make.user` file to override the global `Make.user` file
42
-
in the top-level folder.
42
+
in the top-level folder. After modifying the `Make.user` file if necessary,
43
+
build using: `make -C <build-directory>`.
43
44
44
-
If everything works correctly, you will see a Julia banner and an
45
+
If everything works correctly, there will be a symlink to
46
+
the julia executable in the build directory which can be run as:
47
+
```sh
48
+
./julia
49
+
```
50
+
The actual executable is in `<build-directory>/usr/bin`.
51
+
After running this, you will see a Julia banner and an
45
52
interactive prompt into which you can enter expressions for
46
53
evaluation. (Errors related to libraries might be caused by old,
47
54
incompatible libraries sitting around in your PATH. In this case, try
48
55
moving the `julia` directory earlier in the PATH). Note that most of
49
56
the instructions above apply to unix systems.
50
57
51
58
To run julia from anywhere you can:
52
-
- add an alias (in `bash`: `echo "alias julia='/path/to/install/folder/bin/julia'" >> ~/.bashrc && source ~/.bashrc`), or
59
+
- add an alias (in `bash`: `echo "alias julia='<build-directory>/usr/bin/julia'" >> ~/.bashrc && source ~/.bashrc`), or
53
60
54
-
- add a soft link to the `julia` executable in the `julia` directory to `/usr/local/bin` (or any suitable directory already in your path), or
61
+
- add a soft link to the `julia` executable in the `<build-directory>/usr/bin` directory to `/usr/local/bin` (or any suitable directory already in your path), or
55
62
56
63
- add the `julia` directory to your executable path for this shell session (in `bash`: `export PATH="$(pwd):$PATH"` ; in `csh` or `tcsh`:
0 commit comments