Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

60 lines (44 loc) · 1.96 KB

Contributing to dhtzs.dev

Thank you for considering contributing to this repository! Your help is greatly appreciated.

How to Contribute

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Please include as much detail as possible.

Suggesting Enhancements

  • Search the existing Issues before creating a new enhancement suggestion.
  • When suggesting a new feature, please provide a detailed explanation of your idea and why it would be useful.

Documentation Improvements

  • Documentation improvements are always welcome! If you see something that can be improved, feel free to submit a pull request.

Guidelines for Contributions

Coding Standards

  • Follow the existing code style used in the repository.
  • Ensure your code is well-documented with comments.

Commit Messages

  • Write clear, concise commit messages.
  • Use the present tense ("Add feature" not "Added feature").

Branch Naming

  • Use descriptive branch names, such as feature/add-new-feature or fix/bug-description.

Development Setup

Note

The following instructions assume that you have already installed both Node.js and Hugo to your machine.

  1. Clone the repository and its submodules:
git clone --recurse-submodules https://github.com/dhtzs/dhtzs.dev
  1. Navigate to the repository:
cd dhtzs.dev/
  1. Install dependencies:
npm install
  1. Build the sites:
npm run build

Pull Request Process

  1. Fork the repository and create your branch from main.
  2. Submit your pull request, describing what you did and why.

Code of Conduct

This repository adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.