Skip to content
This repository has been archived by the owner on Jan 17, 2021. It is now read-only.

Latest commit

 

History

History
108 lines (69 loc) · 4.13 KB

CONTRIBUTING.md

File metadata and controls

108 lines (69 loc) · 4.13 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

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, you need internet access.

You'll need following tools:

  • Git
  • VS Code
  • Docker Desktop
  • Docker Extension for VS Code

Build and Run

If you want to understand how the tool works, or debug an issue, you'll want to get the source, build it, and run it locally.

Getting the source code

First, fork the repository so that you can make a Pull Request (PR). Then clone your fork locally:

#!/bin/bash
git clone https://github.com/<your-github-account>/docsify-served

Occasionally you would want to merge changes the upstream repository (the official code repo) with your fork.

#!/bin/bash
cd docsify-served
git checkout master
git pull https://github.com/alertbox/docsify-served master

Build and run from the source

First, you want to ensure Docker Desktop is running on your machine. Then build and run the Dockerfile locally.

#!/bin/bash
cd docsify-served

./run.sh -h localhost:3000 -e 3000 -m `pwd`/docs -v 4.4.1
# Or
./run.sh -h localhost:3000 -e 3000 -m `pwd`/docs -v latest

Then, you launch your favorite browser and visit https://localhost:3000.

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 Docker Images are only supported following platforms: Linux AMD64 Architecture.

These Dockerfile are available: latest | stable

The release.sh script for each Dockerfile contains followings:

  • Expose Port for images
  • Tag images with supported docsify-cli versions
  • Build images locally
  • Push tagged images to Docker Hub

First, you want to ensure Docker Desktop is running on your machine and the scripts are executable. See troubleshooting. Next, bump up of the Dockerfile version if required, then build and release the Dockerfile locally.

#!/bin/bash
cd docsify-served

./release.sh -h localhost:3000 -e 3000 -t "4.4.1"
# Or
./release.sh -h localhost:3000 -e 3000 -t "latest 4.4.1"

Troubleshooting

  • Bash scripts getting terminated Permission denied

    Make it executable with chmod a+x ./build.sh ./run.sh ./release.sh

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.