Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (62 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

99 lines (62 loc) · 3.19 KB

Contributing Guide

How to contribute to "typedoc-plugin-markdown" and associated packages.

Contents

Introduction

Thank you for showing interest in contributing to this project. This guide provides some guidelines for doing so.

If something does not make sense please do not hesitate to ask for help in GitHub Discussions.

Contributing to the public docs

Contributions to the public facing documentation hosted at https://typedoc-plugin-markdown.org are welcome.

The site is built on Nextra and you can edit the MDX files located in the docs folder of the repo.

Please note that the API docs (/pages/api-docs) are autogenerated and should not be edited from that location.

When submitting a PR please use commit message in the format chore(docs): my docs update xxx.

Contributing to the codebase

Getting Started

1. Fork and clone the repository

Start by forking the repository to your own GitHub account. Then, clone the repository to your local machine. Please replace <your-username> with your actual GitHub username.

git clone git@github.com:<your-username>/typedoc-plugin-markdown.git

2. Install dependencies

Navigate to the repository root and install the necessary dependencies:

cd typedoc-plugin-markdown

npm install

3. Build the packages and run tests

Finally, you can build all the packages and run the tests to ensure everything is set up correctly.

Build all packages in the workspace:

npm run build-all

Test all packages in the workspace:

npm run test-all

If the project builds and the tests run successfully you are ready to start contributing to the project.

Please have a look at the codebase and follow documentation comments and provided internal docs.

Submitting a PR

Once you're ready to submit your changes:

  • Push your branch: Push your branch to your forked repository on GitHub.
  • Create a PR: Navigate to the original repository and create a PR from your branch to the main branch.
  • Provide a clear description: Include a detailed description of your changes, why they're necessary, and any issues they resolve.
  • Link to relevant issues: If your PR addresses any open issues, mention them in the description.

Please note we follow Conventional Commits for commit messages.

The commit message should be in the form:

fix(core): my bug fix xxx (#100)

The scope should be one of 'core', 'frontmatter', 'remark', 'docusaurus', 'vitepress', 'githubwiki', 'gitlabwiki', 'docs'. Use 'core' to contribute to the main project.

Acknowledgements

Thank you to all the people who have already contributed to typedoc-plugin-markdown.