Thanks for taking the time to contribute!
The following is a set of guidelines for contributing to BetterDiscord's Installer. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. These guidelines have been adapted from Atom.
What should I know before I get started?
This project and everyone participating in it is governed by the Code of Conduct from the Contributor Covenant. By participating, you are expected to uphold this code. Please report unacceptable behavior.
Unsure where to begin contributing? You can start by looking through help-wanted issues or any issues labelled can't reproduce.
Please follow these steps to have your contribution considered by the maintainers:
- Use a pull request template, if one exists.
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
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.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include
[ci skip]in the commit title
All JavaScript must adhere to the ESLint rules of the repo.
Some other style related points not covered by ESLint:
- Use verbose variable names
- Inline
exports with expressions whenever possible// Use this: export default class ClassName { } // Instead of: class ClassName { } export default ClassName
- Place class properties in the following order:
- Class methods and properties (methods starting with
static) - Instance methods and properties
- Class methods and properties (methods starting with
- Place requires in the following order:
- Built in Node Modules (such as
path) - Repo level global imports (such as
modules,builtins) - Local Modules (using relative paths)
- Built in Node Modules (such as
- Prefer to import whole modules instead of singular functions
- Keep modules namespaced and organized
- This includes Node Modules (such as
fs)
const fs = require("fs"); // Use this
const {readFile, writeFile} = require("fs"); // Avoid this
import Utilities from "./utilities"; // Use this
import {deepclone, isEmpty} from "./utilties"; // Avoid this