Contributing to GitHubDHC

First off, thank you for considering contributing to GitHubDHC! It's people like you that make this template better for everyone.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible using our bug report template.

Guidelines for bug reports:

Use a clear and descriptive title
Describe the exact steps to reproduce the problem
Provide specific examples to demonstrate the steps
Describe the behavior you observed and what you expected to see
Include screenshots if applicable
Note your environment (OS, version, etc.)

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, use our feature request template and include:

A clear and descriptive title
A detailed description of the proposed feature
Examples of how the feature would be used
Why this enhancement would be useful

Pull Requests

Before submitting a pull request:

Fork the repository and create your branch from main
If you've added code, add tests if applicable
Ensure your code follows the existing style
Make sure your commits follow our commit message conventions
Update documentation as needed

Commit Message Convention:

We use Conventional Commits with semantic versioning:

feat: - New features (bumps MINOR version)
fix: - Bug fixes (bumps PATCH version)
feat!: or fix!: - Breaking changes (bumps MAJOR version)
docs: - Documentation only changes
style: - Code style changes (formatting, etc.)
refactor: - Code refactoring
test: - Adding or updating tests
chore: - Maintenance tasks

Examples:

feat: add Python .gitignore template
fix: correct LICENSE badge URL in README
docs: update installation instructions
feat!: change template initialization workflow

Pull Request Process

Update the README.md with details of changes if applicable
Update the CHANGELOG.md is handled automatically by Release Please
The PR will be merged once you have approval from a maintainer
Your PR should pass all checks and have no merge conflicts

Development Setup

Fork and clone the repository
Create a new branch for your feature/fix
Make your changes
Test your changes by creating a new repository from your template
Submit a pull request

Project Structure

GitHubDHC/
├── .github/
│   ├── gitignore-templates/  # Example .gitignore files
│   ├── ISSUE_TEMPLATE/       # Issue templates
│   ├── workflows/            # GitHub Actions
│   └── PULL_REQUEST_TEMPLATE.md
├── assets/                   # Images and CSS for GitHub Pages
├── notes/                    # CHANGELOG, VERSION, TODO
├── README.md
├── LICENSE.md
└── CONTRIBUTING.md

Testing

When making changes to the template initialization workflow, test by:

Creating a new repository from your modified template
Verifying the workflow runs successfully
Checking that all repository references are updated correctly
Confirming the workflow deletes itself after completion

Questions?

Feel free to open an issue for questions or reach out via:

Thank you for your contributions!

3.6 KiB Raw Permalink Blame History