Skip to content

Latest commit

 

History

History
106 lines (68 loc) · 4.18 KB

CONTRIBUTING.md

File metadata and controls

106 lines (68 loc) · 4.18 KB

Contributing to Ponzu

First off, thank you for considering contributing to Ponzu! It's people like you that make Ponzu such a great tool for anime and manga enthusiasts.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to the contributors.

How Can I Contribute?

Reporting Bugs

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

  • Use a clear and descriptive 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.

Suggesting Enhancements

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

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps or point out the part of Ponzu where the suggestion is related to.

Your First Code Contribution

Unsure where to begin contributing to Ponzu? You can start by looking through these beginner and help-wanted issues:

  • Beginner 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 beginner issues.

Pull Requests

The process described here has several goals:

  • Maintain Ponzu's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Ponzu
  • Enable a sustainable system for Ponzu's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Open a pull request with a clear title and description
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing
  4. Wait for a maintainer to review your pull request
  5. Make changes to the pull request if the reviewing maintainer recommends them
  6. Celebrate your success after your pull request is merged!

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 must adhere to the PEP 8 style guide.

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

TypeScript Styleguide

All TypeScript must adhere to TypeScript Standard Style.

CSS Styleguide

All CSS must adhere to the CSS Guidelines.

Documentation Styleguide

  • Use Markdown.
  • Reference methods and classes in markdown with the custom {} notation:
    • Reference classes with {ClassName}
    • Reference instance methods with {ClassName::methodName}
    • Reference class methods with {ClassName.methodName}

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that are bugs.
  • enhancement - Issues that are feature requests.
  • documentation - Issues or pull requests related to documentation.
  • good first issue - Good for newcomers.

Commit and Pull Request Workflow

  1. Fork the repository to your own GitHub account
  2. Clone the project to your machine
  3. Create a branch locally with a succinct but descriptive name
  4. Commit changes to the branch
  5. Following any formatting and testing guidelines specific to this repo
  6. Push changes to your fork
  7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes

Thank you for contributing to Ponzu!