Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (55 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

82 lines (55 loc) · 2.25 KB

Contributing to dotFile

Thank you for your interest in contributing to our project! This document provides guidelines and instructions for contributors.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

How to Contribute

Reporting Bugs

Before creating bug reports, please check the issue list to avoid duplicates. When creating a bug report, include:

  • A clear, descriptive title
  • Detailed steps to reproduce the issue
  • Expected behavior vs actual behavior
  • Screenshots (if applicable)
  • Your environment details (OS, browser, etc.)

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion:

  • Use a clear, descriptive title
  • Provide a detailed description of the proposed functionality
  • Include examples of how the feature would be used
  • Explain why this enhancement would be useful

Pull Request Process

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Make your changes
  4. Run tests if available
  5. Update documentation if needed
  6. Commit your changes (git commit -m 'Add some feature')
  7. Push to your branch (git push origin feature/your-feature)
  8. Create a Pull Request

Pull Request Guidelines

  • Follow the project's coding style and conventions
  • Include tests for new features
  • Update documentation as needed
  • Ensure all tests pass
  • Keep pull requests focused on a single feature/fix

Development Setup

# Clone the repository
git clone https://github.com/username/project.git

Commit Messages

Follow these guidelines for commit messages:

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters
  • Reference issues and pull requests after the first line

Documentation

  • Keep README.md up to date
  • Document new features
  • Update API documentation if applicable
  • Add comments to complex code sections

Getting Help

  • Check out the documentation
  • Create an issue for questions

Recognition

Contributors will be recognized in our README.md and release notes.

Thank you for contributing!