Contribution Guide

If you wish to contribute to the necord codebase or documentation, feel free to fork the repository and submit a pull request. We use ESLint to enforce a consistent coding style, so having that set up in your editor of choice reduces friction contributing to this project.

Setup

You will need Node.js version 18+, and npm.

To get ready to work on the codebase, please do the following:

1. Fork & clone the repository. Make sure you're up-to-date with the master branch!
2. Install the dependencies using yarn install or npm install
3. Code your heart out!
4. Run yarn lint to run ESLint and ensure changes respect our styleguide
5. Submit a pull request (Make sure you follow the conventional commit format)

A high level overview of tools used:

• TypeScript as the development language
• Eslint for code-style
• Prettier for code formatting

Contributing to Documentation

If you want to contribute to the documentation, you can do so by editing the files in the docs repository. The documentation is written in Markdown, so you can use any Markdown editor to make changes. Use yarn dev to start a local server and preview your changes.

Before submitting a pull request, please ensure that:

• Use Markdown for formatting
• Use MDX for embedding React components
• Use GitHub Flavored Markdown for code blocks
• Use anchor links for internal links (e.g. #contributing-to-documentation)

Contributors