Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

53 lines (31 loc) · 2.26 KB
Raw

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.

Contributing to the public docs

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

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

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

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

Contributing to the codebase

For contributing to the plugin codebase, please see the Developer Guide for detailed information about the codebase and development practices.

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.