Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

70 lines (43 loc) · 3.63 KB
Raw

Contributing

We use our wonderful Contributor Covenant for our Contributor Code of Conduct. This same template is used by over 350,000 open source projects. Please read that before you join our project.

Welcome! And thank you for your interest in contributing to the template. There are many ways in which you can contribute, beyond writing code. Here's a high-level overview of how you can get involved:

Contributing to Source Code

The official repo to contribute would be @docsifyjs/docsify.

If you are interested in writing code to fix issues, here's a high-level overview of how you can clone the repos and get started.

Prerequisites

In order to download necessary tools, clone the repo, and install dependencies via bun, you need internet access.

You'll need following tools:

  • Git
  • VS Code and Recommended Extensions
  • Docker Desktop

Build and Run

Open in Dev Container

You can also run this repo locally by following these repetitive steps. First, you want to ensure Docker Desktop (or Rancher Desktop) is running and the repo is cloned to your local machine.

With VS Code:

  • Run task: Reopen in Container
  • Press F5 to preview locally

To refer these two fake files pointing to the originals, you comment out the <script> pointing to the CDN in the docs/index.html.

With Terminal:

  • Run bun build:clean to build from source
  • Create a couple of symlinks 
    cd docs && \
   ln -s ../src/docsify-footer.js docsify-footer.js && \
   ln -s ../dist/docsify-footer.min.js docsify-footer.min.js

To test the changes, you launch your favorite browser and visit https://localhost:4321.

Pull Requests

To enable us to quickly review and accept your pull request, always create one pull request per issue, link the issue in the pull request. Never merge multiple into one unless they all share the same root cause.

Be sure to follow community guidelines and keep the source code changes as small as possible. Avoid any pure document formatting changes to code that has not been modified otherwise.

To avoid multiple pull requests resolving the same issue, let others know you are working on it by saying so in a comment.

Publishing

At present, the plugin published via np to: npm registry, unpkg and jsDelivr CDN. To get familiar, check out npm publishing guide.

Discussion Etiquette

In order to keep the conversations clear and transparent, please limit discussion to English and keep things on topic with the issue. Be considerate to others and try to be courteous and professional at all times.

Thank You

Your contributions to OSS projects, large or small, make great projects like possible. Thank you for taking time to contribute.