Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

72 lines (44 loc) · 1.89 KB
Raw

Contributing to Waifu.it

We love your input! We want to make contributing to this project as easy as possible, whether it's:

  • Submitting a fix
  • Reporting an issue
  • Becoming a maintainer
  • Proposing new features
  • Discussing the current state of the code

Code of Conduct

The code of conduct is described in Code of Conduct.

Frequently Asked Questions (FAQs)

- Q: [The Question?]
- A: [The Answer!]

Feature Request

Great Feature Requests tend to have:

  • A quick idea summary.
  • What & why you wanted to add the specific feature.
  • Additional context like images, links to resources to implement the feature etc, etc.

Development Process

Pull requests are the best way to propose changes. We actively welcome your pull requests and invite you to submit pull requests directly here, and after review, these can be merged into the project.

Pull Requests

  1. Fork the repo and pr to staging branch only.
  2. If you've added code that should be tested, add some test examples.
  3. Ensure to describe your pull request.

Issues

Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. Report a bug by opening a new issue; it's that easy!

Running the API Locally

Requirements

  • Node >= 12.x

1. Installing dependencies

$ npm install

2. Starting the Server

The server will automatically restart when you make changes to the code.

$ npm run dev

And you're done!

License

By contributing to Waifu.it, you agree that your contributions will be licensed under the LICENSE file.