Skip to content

Commit

Permalink
Merge pull request #25 from simwai/dev
Browse files Browse the repository at this point in the history
docs:
  • Loading branch information
simwai authored Apr 20, 2024
2 parents b3ccbcf + b002cb3 commit fa691b6
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Hello! We're thrilled that you're interested in contributing to the Referral Lin

- [🚀 Contributing to Referral Link Inserter](#-contributing-to-referral-link-inserter)
- [📜 Table of Contents](#-table-of-contents)
- [📜 Code of Conduct](#-code-of-conduct)
- [🏁 Getting Started](#-getting-started)
- [🛠️ Development Workflow](#️-development-workflow)
- [Building the Project](#building-the-project)
Expand All @@ -18,10 +17,6 @@ Hello! We're thrilled that you're interested in contributing to the Referral Lin
- [💡 Feature Requests](#-feature-requests)
- [❓ Questions](#-questions)

## 📜 Code of Conduct

This project and everyone participating in it is governed by the [Referral Link Inserter Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]].

## 🏁 Getting Started

Before you begin, please ensure you have a GitHub account and have familiarized yourself with the GitHub flow. Detailed instructions can be found at https://guides.github.com/introduction/flow/.
Expand All @@ -36,39 +31,39 @@ Before you begin, please ensure you have a GitHub account and have familiarized

To build the project, run the following command in your terminal:

\```
```bash
npm run build
\```
```

This script compiles TypeScript files and copies HTML, JSON, and PNG files from the `src` directory to the `dist` directory.

### Running Tests

We use AVA for testing. To run tests, execute:

\```
```bash
npm test
\```
```

This will run all test files located in `./src/tests/` with TypeScript support.

### Linting

To ensure code quality and consistency, run the linter:

\```
```bash
npm run lint
\```
```

This uses XO to enforce a consistent code style.

### Formatting

To automatically format your code, you can run:

\```
```bash
npm run format
\```
```

This command will fix linting errors and format the code according to the defined rules in XO configuration.

Expand Down

0 comments on commit fa691b6

Please sign in to comment.