Contributing

A basic overview of code-style & preferred methods of doing things.

If you have any questions or suggestions, please create a ticket. We are open to suggestions.

Styleguides

Git commit messages

Be explicit about what you changed. ("Fixed bug" vs "Fixed bug relating to incorrect import")
reference issue numbers if possible ("Fixed incorrect env var as reported in #3")

Code preferences

These are not strictly necessary however it is nice to have a codebase where everyone's code looks the same

Verboseness is preferred, be explicit with your types and interfaces. If you use an object more than once or pass it around, create an interface or type.

Enums

enums are preferred due to their nicer accessor patterns as well as making potential refactors easier.

/** Preferred */
export enum LoggerLayers {
	client = "client",
	slashCommands = "slashCommands"
}

const logger = createLayeredLogger(LoggerLayers.client)

/** Allowed but not preferred */
export type loggerLayer = "client" | "server"
const logger = createLayeredLogger("client")

Prettier

Prettier is not installed due to its habit of making code look terrible. We trust that contributors will format their code to match the style in the codebase. A new developer should not be able to tell code apart by contributor.

Potentially at some-point ESLint rules may be configured to further enforce code style however as it is now, We trust contributors will format their code to match the style in the codebase.

ESLint

Eslint should be run on save and before committing.

Try & Catch

Functions where any form of complex actions occur should be wrapped in try catch blocks. Errors preferably must be handled.

const myComplexFunc = async (): myReturnValue => {
	try {
		logger.info("Describe whats happening");

		const foo = await callNetworkingFunction("bar", "baz");
		return foo.zoo
	} catch (e) {
		/** if 'e' is more complex handle different error messages */
		logger.error("Describe what went wrong", e);
	} finally {
		logger.info("Describe what succeeded");
	}	
}

Tabs vs Spaces

Tabs, ESLint enforces this.

2.1 KiB Raw Blame History