Skip to content

Dog-Face-Development/DFD-Code-Style-Guide

Repository files navigation

Code Style Guide
Dog Face Development Co. Code Style Guide

The Dog Face Development Co. Code Style Guide, published as Markdown files and as a web page.

Docker State GitHub Pages State Playwright Test State CodeQL State GitHub Version GitHub Issues GitHub Pull Requests Discord Server ID GitHub Languages

Key FeaturesHow To UseContributingCredits & Contributors

Key Features

  • Clear style guide.
  • Available for many programming languages.
  • Available for many programming platforms.
  • Consistency across all projects.
  • Easy to implement.
  • Reusable standards.
  • Available in Markdown and on the web.
  • Cross platform, web browser based.

How To Use

To access the latest version of the website visit it at https://dog-face-development.github.io/DFD-Code-Style-Guide/.

To clone and run your own copy of this website, you'll need Git installed on your computer. If you would rather not use Git, you can just download the code from GitHub above. From your command line:

# Clone this repository
$ git clone https://github.com/Dog-Face-Development/DFD-Code-Style-Guide.git

# Go into the repository
$ cd DFD-Code-Style-Guide

# Run the webpage
$ index.html

You can also pull the Docker image from GitHub Packages. From your command line:

# Pull image
$ docker pull docker pull ghcr.io/dog-face-development/dfd-code-style-guide:master

# Run container
$ docker run -d -p 8000:80 docker pull ghcr.io/dog-face-development/dfd-code-style-guide:master

# Now, navigate to localhost in your browser to see the webpage

If support is required, please open a GitHub Discussion or join our Discord.

Contributing

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us (including how to sign our CLA).

Credits

This software uses the following open source packages, projects, services or websites:

GitHub W3C W3Schools Simple Analytics
GitHub W3C W3Schools Simple Analytics
Web - Plans Web - Donate Web - Pro Web - Plans

Contributors

You may also like...

  • ProgramVer - An open-source, Python GUI version window to show copyright info and licenses.
  • PyWorkout - A minimal CLI to keep you inspired during your workout!
  • PyAvatar - Easily display all of your creative avatars to keep them consistent across websites.

License

This project is licensed under the Creative Commons Attribution 4.0 International Public License - see the LICENSE file for details. See the Privacy Policy, Terms and Conditions, and EULA for legal information.