Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

43 lines (34 loc) · 2.4 KB

Contributing to Atom-Julia

Julia support in Atom is in a very, very early state – we love to have people kicking the tires, but be ready to get your hands dirty!

Help & Bug Reporting

This project is composed of many sub-projects, and it can be hard to know the appropriate place to file issues. For that reason we prefer that non-developers report issues on the Julia discussion forum under the "usage" category with "juno" tag, and we can funnel things through to the right places from there.

Contributing

If you have feature ideas you'd like to implement, or bugs you'd like to fix, feel free to open a discussion under the "development" category with "juno" tag – we're always happy to help people flesh out their ideas or get unstuck on problems.

If you look over the GitHub issues for the various packages, you may notice some labelled up for grabs. These are features or bugs for which the implementation or fix is reasonably straightforward – they might take a few hours of effort or more, but they won't involve enormous expert-level challenges. As above, feel free to open up a discussion on these and we'll help you get going.

Please read the developer set up guidelines to get started. There's a basic development tutorial there, but as you get deeper you'll want some more general resources:

  • Julia Documentation – for learning about the Julia language.
  • MDN – by far the best reference on the JavaScript language and browser window APIs.
  • CoffeeScript – Atom and its packages use this to make working with JS a little more convenient.
  • The Atom Docs – the Atom Flight Manual is a very readable introduction to Atom's internals, and the API docs are a useful reference.
  • julia-client developer docs – These docs go into more detail about the internals of this project and the development workflow.

Most open source projects, including ours, use git to help work together. There are plenty of git tutorials around, and the various GUI clients (e.g. GitHub for Windows/Mac, SourceTree) are very helpful for learning the ropes.