Skip to content

Latest commit

 

History

History
129 lines (83 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

129 lines (83 loc) · 2.89 KB

Contributing to mdstfu

Thank you for considering contributing to mdstfu! Contributions are essential for making this project better, and your support is greatly appreciated. Here's a guide to help you get started.

Table of Contents

Code of Conduct

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

Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js (>= 14.x)
  • npm (>= 7.x)
  • Git

Setting Up

  1. Fork and Clone the Repository:
git clone https://github.com/colack/mdstfu.git
cd mdstfu
  1. Install Dependencies:
npm install
  1. Verify the Setup by running the tests to make sure everything works:
npm test

Now, you're ready to start contributing!

Building the Project

To build the project, run:

npm run build

The build output will be in the dist/ directory. Ensure you rebuild after making changes to TypeScript files in the src/ directory.

Running Tests

We use Jest for testing. To run the tests, use:

npm test

To run tests in watch mode during development, use:

npm run test:watch

Before submitting any code, make sure that all tests pass.

Making a Pull Request

To make a contribution:

  1. Create a Feature Branch:
git checkout -b feature/my-feature
  1. Make your Changes:
  • Follow the Commit Guidelines.
  • Add tests for any new features or bug fixes.
  • Run npm test to ensure everything works.
  1. Push Your Changes:
git push origin feature/my-feature
  1. Submit a Pull Request:
  • Go to the pull requests tab on the repository.
  • Submit a new pull request with a description of your changes.

Issue Guidelines

When submitting a issue, please include:

  • A clear title and description.
  • Steps to reproduce the issue, if applicable.
  • Relevant screenshots, code snippets, or error messages.

Commit Guidelines

To maintain consistency, please follow these commit guidelines:

  • Format: type(scope): message
    • type: Describes the kind of change (e.g., feat, fix, docs, style, refactor, test, chore).
    • scope: Optional, describes what part of the project is affected.
    • message: A brief description of the change.

Examples:

  • feat(parser): add support for custom delimiters
  • fix(parser): handle empty strings

Thank you for your contributions! 🎉