Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (45 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 3.22 KB
Raw

Contributing to ComfyUI-DiscordSend

First off, thank you for considering contributing to ComfyUI-DiscordSend! It's people like you that make this such a great tool.

Code of Conduct

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

How Can I Contribute?

Reporting Bugs

If you've noticed a bug, open a new issue! It's generally best if you get confirmation of your bug this way before starting to code.

Suggesting Enhancements

If you have a feature request, open a new issue! It's generally best to get approval for your feature request this way before starting to code.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through good first issue and help wanted issues:

  • Good first issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than good first issue issues.

Pull Requests

  1. Fork & create a branch. Fork the repository and create a branch with a descriptive name. A good branch name would be (where issue #325 is the ticket you're working on): git checkout -b 325-add-japanese-translations
  2. Set up your development environment. To get started, you'll want to clone the repository and set up a virtual environment. 
    git clone https://github.com/AEmotionStudio/ComfyUI-DiscordSend.git
cd ComfyUI-DiscordSend
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
  3. Implement your fix or feature. At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first.
  4. Make a Pull Request. At this point, you should switch back to your master branch and make sure it's up to date with the latest upstream version of the repository. 
    git remote add upstream git@github.com:AEmotionStudio/ComfyUI-DiscordSend.git
git checkout master
git pull upstream master
    Then update your feature branch from your local copy of master, and push it! 
    git checkout 325-add-japanese-translations
git rebase master
git push --force-with-lease origin 325-add-japanese-translations
    Finally, go to GitHub and make a Pull Request.

Styleguides

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 Styleguide

All Python code should adhere to PEP 8.