Skip to content

Latest commit

 

History

History
163 lines (106 loc) · 7.52 KB

CONTRIBUTING.md

File metadata and controls

163 lines (106 loc) · 7.52 KB

Contributing to gulag

👍🎉 Thanks for taking the time to contribute! 🎉👍

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

Table of Contents

Code of Conduct

How Can I Contribute?

Style Guides

Code of Conduct

This project and everyone participating in it must follow the gulag 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 gulag. Following these guidelines help maintainers and the community understand your report 📝, reproduce the bug 💻, and find related reports 🔎.

Before creating bug reports, please perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of creating a new one. When creating a bug report please use as many details as possible.

NOTE: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub Issues. Create an issue and provide the following information by filling in the following template:

---
name: Bug Report
about: Create a report to help us improve.
---

### Prerequisites

* [ ] Put an X between the brackets on this line if you have done the following:
    * Checked that your issue isn't already filed: <https://github.com/search?l=&p=2&q=is%3Aissue+repo%3Acmyui%2Fgulag>

### Description

### Steps to Reproduce

1.
2.
3.

**Expected behavior:**

**Actual behavior:**

**Reproduces how often:**

### Version

### Additional Information

Explain the problem and include additional details to help maintainers reproduce the problem.

  • Use a clear and descrptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files, or GitHub projects, or copy/pasteable snippits, which you use in those examples. If you're providing snippets in the issue, use markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with the behavior.
  • Explain which behavior you expected to see and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Provide more context by answering these questions:

  • Did the problem start happening recently (e.g. after updating to a new version of gulag) or was this always the problem?
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under what conditions it normally happens.

Include details about your configuration and environment:

  • Which version of gulag are you using? You can get the exact version when you first start gulag by running python3.9 main.py.
  • What's the name and version of the OS you're using?

Suggesting Ideas

This section guides you through submitting an idea for gulag, including completely new features and minor improvements to existing functionality. Follow these guidelines to help maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

Before suggesting any ideas, please perform a cursory search to see if your idea has already been suggested. You may find out you don't need to create one. When suggesting an idea, please include as many details as possible.

How Do I Submit A (Good) Idea?

Ideas are tracked as GitHub Issues. Create an issue and provide the following information by filling in the following template:

---
name: Feature request
about: Suggest an idea for this project
---

## Summary

## Motivation

## Describe alternatives you've considered

## Additional context

Explain the idea and include additional details to help maintainers understand your suggestion.

  • Use a clear and descrptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested idea in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippits which you use in those examples, as markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
  • Explain why this idea would be useful to most gulag users.
  • Specify which version of gulag you're using. You can get the exact version when you first start gulag by running python3.9 main.py.
  • Specify the name and version of the OS you're using.

Your First Contribution

Unsure of where to begin contributing to gulag? You can start by looking through the good first issue issues. These issues usually only require a few lines of code, and a test or two.

Pull Requests

The process described here has several goals:

  • Maintain gulag's quality.
  • Fix problems that are important to users.
  • Engage the community in working towards the best possible bancho protocol.
  • Enable a sustainable system for gulag's maintainers to review contributions.

Please make sure to follow the Style Guides to have your contribution considered by maintainers.

While the above prerequisites must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be accepted.

Style Guides

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.
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code.
    • 🐎 :racehorse: when improving performance.
    • 📝 :memo: when writing documentation.
    • 🐛 :bug: when fixing a bug.
    • 🔥 :fire: when removing code or files.
    • 🔒 :lock: when dealing with security.
    • ⬆️ :arrow_up: when upgrading dependencies.
    • ⬇️ :arrow_down: when downgrading dependencies.

Python Style Guide

TODO: I'll leave this up to cmyui.