Skip to content
This repository was archived by the owner on Oct 19, 2018. It is now read-only.

Files

Latest commit

 

History

History
41 lines (33 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

41 lines (33 loc) · 1.92 KB

Contributing

First off, thanks for taking the time to contribute! You are awesome.

The following is a set of guidelines for contributing to 9anime Companion

Table of Contents

Goal

9anime Companion aims to give users helpful features that improves their 9anime experience.

How Can I Contribute?

ℹ️ Remember to fill in the template. You will get the template whenever you open a new issue/pr.

Reporting bugs

  • Before reporting a bug, please do a quick search in the Issue Tracker.
  • If there are no duplicates then file a new issue.
  • Be sure to include a proper description and steps to reproduce the issue.

Suggesting enhancements/features

  • Before suggesting an enhancement/feature, please do a quick search in the Issue Tracker.
  • If there are no duplicates then file a new issue.
  • Be sure to include a proper description as well.

Pull Requests

  • Follow the styleguides as much as you can. Use npm run linter periodically to check.
  • Do not include issue numbers in the PR title.
  • Be sure to document your code. Without proper documentation your PR won't be accepted.
  • Run the tests once using npm run test before submitting your PR.
  • Describe what your code does in the PR. A proper description is a must.
  • End all files with a newline.

Styleguides