Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

93 lines (62 loc) · 3.92 KB

Contributing to ECS Discord Bot

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

Code of Conduct

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

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for ECS Discord Bot. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting a Bug Report

  • Check the issue tracker to see if the issue has already been reported.
  • Perform a search to see if the issue has been addressed in other ways.

How Do I Submit a Bug Report?

Bugs are tracked as GitHub issues. After you've determined that your bug is new, create an issue and provide the following information:

  • Use a clear and descriptive title.
  • Describe the 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 and animated GIFs if applicable.
  • Specify which version of the project you're using.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to an existing functionality.

Before Submitting an Enhancement

  • Check the issue tracker to see if the enhancement has already been suggested.
  • Perform a search to see if the enhancement or a similar one has been proposed.

How Do I Submit an Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. After you've determined that your enhancement is new, create an issue and provide the following information:

  • Use a clear and descriptive title.
  • Provide a step-by-step description of the suggested enhancement.
  • Explain why this enhancement would be useful.
  • Include any relevant examples, screenshots, or references.

Submitting Changes

How Do I Submit Changes?

  1. Fork the repository.
  2. Clone your fork to your local machine.
  3. Create a new branch: git checkout -b my-branch-name.
  4. Make your changes and commit them.
  5. Push to your fork and submit a pull request.
  6. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

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.

Python Style Guide

  • Follow PEP 8 guidelines.
  • Use black for code formatting.
  • Include docstrings for all public methods and functions.

Additional Resources