Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

77 lines (52 loc) · 2.6 KB

Contributing to WildDuck-UI

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

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

Code of Conduct

The code of conduct is described in CODE_OF_CONDUCT.md.

Our Development Process

All changes happen through pull requests. 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.

Using the Project's Standard Commit Messages

This project is using the conventional commits standard. Please follow these steps to ensure your commit messages are standardized:

  1. Make sure your shell path is in the root of the project (not inside any of the packages).
  2. Run npm i.
  3. Stage the files you are commiting with git add [files].
  4. git commit -m < you_message >:
    1. Prefix commit message with fix: or feat: according to type of commit.
    2. Write a short, imperative tense description of the change.
    3. Provide a issue number if your're creating pull request related the specific issue

Pull Requests

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

wildduck-ui

   git add [files]
   git commit -m 'your commit message'
   git push <branch_name>

Quickstart Local Frontend Development

Issues

We use GitHub issues to track public bugs. 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!

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.

License

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