Skip to content

Latest commit

 

History

History
107 lines (74 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

107 lines (74 loc) · 3.93 KB

Certainly! I'll create a CONTRIBUTION.md file for @Deertick based on the template provided by Mozilla Science Lab. Here's a draft:

Contributing to DeerTick

Thank you for your interest in contributing to DeerTick! This document outlines the process for contributing to our project.

Table of Contents

  1. Getting Started
  2. How Can I Contribute?
  3. Style Guides
  4. Community

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed the latest version of Python
  • You have a basic understanding of Git and GitHub

Setting up your development environment

  1. Fork the DeerTick repository on GitHub
  2. Clone your fork locally: 
    git clone https://github.com/your-username/deertick.git
  3. Create a virtual environment and activate it: 
    python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`
  4. Install the development dependencies: 
    pip install -r requirements-dev.txt

How Can I Contribute?

Reporting Bugs

If you encounter a bug, please open an issue on our GitHub repository. When filing a bug report, please include:

  • A clear and descriptive title
  • A detailed description of the issue
  • Steps to reproduce the behavior
  • What you expected to happen
  • What actually happened
  • Any relevant screenshots or error messages

Suggesting Enhancements

We welcome suggestions for enhancements! Please open an issue on our GitHub repository and include:

  • A clear and descriptive title
  • A detailed description of the proposed enhancement
  • Any relevant examples or mock-ups

Pull Requests

  1. Create a new branch for your feature or bugfix: 
    git checkout -b feature/your-feature-name
  2. Make your changes and commit them with a clear commit message
  3. Push your branch to your fork: 
    git push origin feature/your-feature-name
  4. Open a pull request against the main branch of the DeerTick repository
  5. Ensure your PR description clearly describes the problem and solution

Style Guides

Git 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 or less
  • Reference issues and pull requests liberally after the first line

Python Style Guide

We follow the PEP 8 style guide for Python code. Please ensure your code adheres to these guidelines.

Documentation Style Guide

  • Use Markdown for documentation
  • Reference function names, variables, and filenames using backticks (`)

Community

Code of Conduct

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

Communication Channels

  • GitHub Issues: For bug reports, feature requests, and detailed discussions
  • Discord Server: For quick questions and community chat

Thank you for contributing to DeerTick! We appreciate your efforts to make our project better.

This CONTRIBUTION.md file provides a comprehensive guide for potential contributors to @Deertick's project. It covers the essential aspects of contributing, including setting up the development environment, reporting bugs, suggesting enhancements, submitting pull requests, and following style guides. The document also emphasizes the importance of community and provides information on the code of conduct and communication channels.

You may want to customize this template further based on the specific needs and workflows of the DeerTick project. For example, you might add more detailed information about the project's architecture, testing procedures, or release process if these are important for contributors to know.