Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

76 lines (57 loc) · 2 KB
Raw

Contributing to def-gen

Thank you for your interest in contributing to def-gen! We welcome contributions from the community and are grateful for your help in improving the project.

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please read it to understand the expectations for all contributors.

How to Contribute

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/veloii/def-gen.git
cd def-gen
  3. Create a new branch for your feature or bugfix: 
    git checkout -b my-feature-branch

Development Setup

To set up your development environment, follow these steps:

  1. Install the dependencies using pnpm:

    pnpm install

  2. Build the project:

    pnpm build

Building the Project

To build the project, use the following command:

pnpm build

This will compile the TypeScript files and generate the output in the dist directory.

Running Tests

To run the tests, use the following command:

pnpm test

We use Vitest for testing. Make sure all tests pass before submitting your changes.

Submitting Changes

  1. Commit your changes using a descriptive commit message: 
    git commit -m "Add feature X"
  2. Push your changes to your forked repository: 
    git push origin my-feature-branch
  3. Open a pull request on GitHub and describe the changes you have made.

License

By contributing to def-gen, you agree that your contributions will be licensed under the MIT License.