Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (63 loc) · 7.21 KB

CONTRIBUTING.md

File metadata and controls

99 lines (63 loc) · 7.21 KB

Notes for Julia Contributors

Hi! If you are new to the Julia community: welcome, and thanks for trying Julia. Please be sure to respect our community standards in all interactions.

If you are already familiar with Julia itself, this blog post by Katharine Hyatt on Making your first Julia pull request is a great way to get started.

Important

If your pull request contains substantial contributions from a generative AI tool, please disclose so with details, and review all changes before opening. This also applies to other content, such as issues, discussions, and comments.

Learning Julia

The learning page has a great list of resources for new and experienced users alike.

Filing an issue

Before filing an issue

  • Reporting a potential bug? Please read the "How to file a bug report" section to make sure that all necessary information is included.

  • Contributing code? Be sure to review the contributor checklist for helpful tips on the tools we use to build Julia.

  • Library feature requests are generally not accepted on this issue tracker. New libraries should be developed as packages. Discuss ideas for libraries at the Julia Discourse forum. Doing so will often lead to pointers to existing projects and bring together collaborators with common interests.

How to file a bug report

A useful bug report filed as a GitHub issue provides information about how to reproduce the error.

  1. Before opening a new GitHub issue:
  • Try searching the existing issues or the Julia Discourse forum to see if someone else has already noticed the same problem.
  • Try some simple debugging techniques to help isolate the problem.
    • Try running the code with the debug build of Julia with make debug, which produces the usr/bin/julia-debug.
    • Consider running julia-debug with a debugger such as gdb or lldb. Obtaining even a simple backtrace is very useful.
    • If Julia segfaults, try following these debugging tips to help track down the specific origin of the bug.

  1. If the problem is caused by a Julia package rather than core Julia, file a bug report with the relevant package author rather than here.

  2. When filing a bug report, provide where possible:

  • The full error message, including the backtrace.
  • A minimal working example, i.e. the smallest chunk of code that triggers the error. Ideally, this should be code that can be pasted into a REPL or run from a source file. If the code is larger than (say) 50 lines, consider putting it in a gist.
  • The version of Julia as provided by the versioninfo() command. Occasionally, the longer output produced by versioninfo(verbose = true) may be useful also, especially if the issue is related to a specific package.
  1. When pasting code blocks or output, put triple backquotes (```) around the text so GitHub will format it nicely. Code statements should be surrounded by single backquotes (`). Be aware that the @ sign tags users on GitHub, so references to macros should always be in single backquotes. See GitHub's guide on Markdown for more formatting tricks.

Submitting contributions

Working on issues

We rarely assign issues to contributors, especially not to new contributors. If you want to work on an issue, just go ahead and open a pull request. There's no need to ask for permission or comment that you're planning to work on it—just start working and submit your PR when ready.

This policy exists to avoid "cookie licking" (claiming an issue without following through), which can discourage others from contributing. If someone else is already working on the same issue, that's okay—multiple approaches can be valuable, and reviewers will help sort out which solution is best.

Contributor Checklist

  • Create a GitHub account.

  • Fork Julia.

  • Build the software and libraries (the first time takes a while, but it's fast after that). Detailed build instructions are in the README. Julia depends on several external packages; most are automatically downloaded and installed, but are less frequently updated than Julia itself.

  • Keep Julia current. Julia is a fast-moving target, and many details of the language are still settling out. Keep the repository up-to-date and rebase work-in-progress frequently to make merges simpler.

  • Learn to use git, the version control system used by GitHub and the Julia project. Try a tutorial such as the one provided by GitHub.

  • Review discussions on the Julia Discourse forum.

  • If your pull request contains substantial contributions from a generative AI tool, please disclose so with details, and review all changes before opening.

  • Relax and have fun!

Guidance for specific changes

The julia project maintains a more in-depth Contributor's Guide as part of our developer documentation. Here you can find more in-depth guidance for how to write specific kinds of changes. In particular, you want want to read:

Resources