:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
The following is a set of guidelines for contributing to Pulsar and its packages, which are hosted in the pulsar-edit Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
I don't want to read this whole thing, I just have a question!!!
What should I know before I get started?
This project and everyone participating in it is governed by the Atom Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com.
Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.
We have an official message board with a detailed FAQ and where the community chimes in with helpful advice if you have questions.
Pulsar is a large open source project — it's made up of over 200 repositories. When you initially consider contributing to Pulsar, you might be unsure about which of those 200 repositories implements the functionality you want to change or report a bug for. This section should help you with that.
Pulsar is intentionally very modular. Nearly every non-editor UI element you interact with comes from a package, even fundamental things like tabs and the status-bar. These packages are packages in the same way that packages in the Atom package repository are packages, with one difference: they are bundled into the default distribution.
To get a sense for the packages that are bundled with Atom, you can go to Settings
> Packages
within Atom and take a look at the Core Packages section.
Here's a list of the big ones:
language-[name]
. Use these for feedback on syntax highlighting issues that only appear for a specific language.-ui
suffix) provide only styling and it's possible that a bundled package is responsible for a UI issue. There are other bundled UI themes, such as one-light-ui.apm
command line tool (Atom Package Manager). You should use this repository for any contributions related to the apm
tool and for publishing packages.There are many more, but this list should be a good starting point. For more information on how to work with Atom's official packages, see Contributing to Atom Packages.
Also, because Atom is so extensible, it's possible that a feature you've become accustomed to in Atom or an issue you're encountering isn't coming from a bundled package at all, but rather a community package you've installed. Each community package has its own repository too.
There are a few conventions that have developed over time around packages:
language-[language-name]
[theme-name]-ui
[theme-name]-syntax
one-dark-ui
and one-dark-syntax
autocomplete-[what-they-autocomplete]
— ex: autocomplete-cssWhen we make a significant decision in how we maintain the project and what we can or cannot support, we will document it in the atom/design-decisions repository. If you have a question around how we do things, check to see if it is documented there. If it is not documented there, please open a new topic on Github Discussions, the official Atom message board and ask your question.
This section guides you through submitting a bug report for Atom. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
Console.app
under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.styles.less
. Try running in Safe Mode and using a different theme or comment out the contents of your styles.less
to see if that fixes the problem.Provide more context by answering these questions:
Include details about your configuration and environment:
atom -v
in your terminal, or by starting Atom and running the Application: About
command from the Command Palette.apm list --installed
.config.cson
, keymap.cson
, snippets.cson
, styles.less
and init.js
to customize Atom? If so, provide the contents of those files, preferably in a code block or with a link to a gist.This section guides you through submitting an enhancement suggestion for Atom, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:
atom -v
in your terminal, or by starting Atom and running the Application: About
command from the Command Palette.Unsure where to begin contributing to Atom? You can start by looking through these beginner
and help-wanted
issues:
beginner
issues.Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
If you want to read about using Atom or developing packages in Atom, the Atom Flight Manual is free and available online. You can find the source to the manual in atom/flight-manual.atom.io.
Atom Core and all packages can be developed locally. For instructions on how to do this, see the following sections in the Atom Flight Manual:
The process described here has several goals:
Please follow these steps to have your contribution considered by the maintainers:
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
[ci skip]
in the commit title:art:
when improving the format/structure of the code:racehorse:
when improving performance:non-potable_water:
when plugging memory leaks:memo:
when writing docs:penguin:
when fixing something on Linux:apple:
when fixing something on macOS:checkered_flag:
when fixing something on Windows:bug:
when fixing a bug:fire:
when removing code or files:green_heart:
when fixing the CI build:white_check_mark:
when adding tests:lock:
when dealing with security:arrow_up:
when upgrading dependencies:arrow_down:
when downgrading dependencies:shirt:
when removing linter warningsAll JavaScript code is linted with Prettier.
{...anotherObj}
) to Object.assign()
export
s with expressions whenever possible
```js
// Use this:
export default class ClassName {}
// Instead of: class ClassName {
} export default ClassName
* Place requires in the following order:
* Built in Node Modules (such as `path`)
* Built in Atom and Electron Modules (such as `atom`, `remote`)
* Local Modules (using relative paths)
* Place class properties in the following order:
* Class methods and properties (methods starting with `static`)
* Instance methods and properties
* [Avoid platform-dependent code](https://flight-manual.atom.io/hacking-atom/sections/cross-platform-compatibility/)
### CoffeeScript Styleguide
* Set parameter defaults without spaces around the equal sign
* `clear = (count=1) ->` instead of `clear = (count = 1) ->`
* Use spaces around operators
* `count + 1` instead of `count+1`
* Use spaces after commas (unless separated by newlines)
* Use parentheses if it improves code clarity.
* Prefer alphabetic keywords to symbolic keywords:
* `a is b` instead of `a == b`
* Avoid spaces inside the curly-braces of hash literals:
* `{a: 1, b: 2}` instead of `{ a: 1, b: 2 }`
* Include a single line of whitespace between methods.
* Capitalize initialisms and acronyms in names, except for the first word, which
should be lower-case:
* `getURI` instead of `getUri`
* `uriToOpen` instead of `URIToOpen`
* Use `slice()` to copy an array
* Add an explicit `return` when your function ends with a `for`/`while` loop and
you don't want it to return a collected array.
* Use `this` instead of a standalone `@`
* `return this` instead of `return @`
* Place requires in the following order:
* Built in Node Modules (such as `path`)
* Built in Atom and Electron Modules (such as `atom`, `remote`)
* Local Modules (using relative paths)
* Place class properties in the following order:
* Class methods and properties (methods starting with a `@`)
* Instance methods and properties
* [Avoid platform-dependent code](https://flight-manual.atom.io/hacking-atom/sections/cross-platform-compatibility/)
### Specs Styleguide
- Include thoughtfully-worded, well-structured [Jasmine](https://jasmine.github.io/) specs in the `./spec` folder.
- Treat `describe` as a noun or situation.
- Treat `it` as a statement about state or how an operation changes state.
#### Example
```coffee
describe 'a dog', ->
it 'barks', ->
# spec here
describe 'when the dog is happy', ->
it 'wags its tail', ->
# spec here
{}
notation:
{ClassName}
{ClassName::methodName}
{ClassName.methodName}
# Public: Disable the package with the given name.
#
# * `name` The {String} name of the package to disable.
# * `options` (optional) The {Object} with disable options (default: {}):
# * `trackTime` A {Boolean}, `true` to track the amount of time taken.
# * `ignoreErrors` A {Boolean}, `true` to catch and ignore errors thrown.
# * `callback` The {Function} to call after the package has been disabled.
#
# Returns `undefined`.
disablePackage: (name, options, callback) ->
This section lists the labels we use to help us track and manage issues and pull requests. Most labels are used across all Atom repositories, but some are specific to atom/atom
.
GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in. For example, you might be interested in open issues across atom/atom
and all Atom-owned packages which are labeled as bugs, but still need to be reliably reproduced or perhaps open pull requests in atom/atom
which haven't been reviewed yet. To help you find issues and pull requests, each label is listed with search links for finding open items with that label in atom/atom
only and also across all Atom repositories. We encourage you to read about other search filters which will help you write more focused queries.
The labels are loosely grouped by their purpose, but it's not required that every issue has a label from every group or that an issue can't have more than one label from the same group.
Please open an issue on atom/atom
if you have suggestions for new labels, and if you notice some labels are missing on some repositories, then please open an issue on that repository.
Label name | atom/atom :mag_right: |
atom ‑org :mag_right: |
Description |
---|---|---|---|
enhancement |
search | search | Feature requests. |
bug |
search | search | Confirmed bugs or reports that are very likely to be bugs. |
question |
search | search | Questions more than bug reports or feature requests (e.g. how do I do X). |
feedback |
search | search | General feedback more than bug reports or feature requests. |
help-wanted |
search | search | The Atom core team would appreciate help from the community in resolving these issues. |
beginner |
search | search | Less complex issues which would be good first issues to work on for users who want to contribute to Atom. |
more-information-needed |
search | search | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
needs-reproduction |
search | search | Likely bugs, but haven't been reliably reproduced. |
blocked |
search | search | Issues blocked on other issues. |
duplicate |
search | search | Issues which are duplicates of other issues, i.e. they have been reported before. |
wontfix |
search | search | The Atom core team has decided not to fix these issues for now, either because they're working as intended or for some other reason. |
invalid |
search | search | Issues which aren't valid (e.g. user errors). |
package-idea |
search | search | Feature request which might be good candidates for new packages, instead of extending Atom or core Atom packages. |
wrong-repo |
search | search | Issues reported on the wrong repository (e.g. a bug related to the Settings View package was reported on Atom core). |
Label name | atom/atom :mag_right: |
atom ‑org :mag_right: |
Description |
---|---|---|---|
windows |
search | search | Related to Atom running on Windows. |
linux |
search | search | Related to Atom running on Linux. |
mac |
search | search | Related to Atom running on macOS. |
documentation |
search | search | Related to any type of documentation (e.g. API documentation and the flight manual). |
performance |
search | search | Related to performance. |
security |
search | search | Related to security. |
ui |
search | search | Related to visual design. |
api |
search | search | Related to Atom's public APIs. |
uncaught-exception |
search | search | Issues about uncaught exceptions, normally created from the Notifications package. |
crash |
search | search | Reports of Atom completely crashing. |
auto-indent |
search | search | Related to auto-indenting text. |
encoding |
search | search | Related to character encoding. |
network |
search | search | Related to network problems or working with remote files (e.g. on network drives). |
git |
search | search | Related to Git functionality (e.g. problems with gitignore files or with showing the correct file status). |
atom/atom
Topic CategoriesLabel name | atom/atom :mag_right: |
atom ‑org :mag_right: |
Description |
---|---|---|---|
editor-rendering |
search | search | Related to language-independent aspects of rendering text (e.g. scrolling, soft wrap, and font rendering). |
build-error |
search | search | Related to problems with building Atom from source. |
error-from-pathwatcher |
search | search | Related to errors thrown by the pathwatcher library. |
error-from-save |
search | search | Related to errors thrown when saving files. |
error-from-open |
search | search | Related to errors thrown when opening files. |
installer |
search | search | Related to the Atom installers for different OSes. |
auto-updater |
search | search | Related to the auto-updater for different OSes. |
deprecation-help |
search | search | Issues for helping package authors remove usage of deprecated APIs in packages. |
electron |
search | search | Issues that require changes to Electron to fix or implement. |
Label name | atom/atom :mag_right: |
atom ‑org :mag_right: |
Description |
---|---|---|---|
work-in-progress |
search | search | Pull requests which are still being worked on, more changes will follow. |
needs-review |
search | search | Pull requests which need code review, and approval from maintainers or Atom core team. |
under-review |
search | search | Pull requests being reviewed by maintainers or Atom core team. |
requires-changes |
search | search | Pull requests which need to be updated based on review comments and then reviewed again. |
needs-testing |
search | search | Pull requests which need manual testing. |