Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

55 lines (32 loc) · 1.96 KB

Contributing to QuickWiki

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

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features and UI/UX changes
  • If you are beginner then you can contribute by improving the structure or the layout or any mistakes in the repository.

We Develop with Netlify

Our project is currently hosted on Netlify and you can visit it on quickwiki.netlify.app

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow ). We actively welcome your pull requests,

  1. Star this repository.
  2. Create an issue with description and wait for approval.
  3. Fork the repo and create your branch from main.
  4. If you've added code that should be tested, add tests.
  5. If you've changed APIs, update the documentation.
  6. Ensure the test suite passes.
  7. Make sure your code lints.
  8. Issue that pull request!

Any contributions you make will be under the GNU Software License

In short, when you submit code changes, your submissions are understood to be under the same GNU License that covers the project. Feel free to contact the maintainers if that's a concern.

Great Bug Reports tends to have:

  • A quick summary and/or background
  • Should be specific!
  • What you expected would happen
  • What's actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

License

By contributing, you agree that your contributions will be licensed under its GNU License.

Note

Before contributing please create an issue first so that I can assign you and you can start working on it.