Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 2.71 KB
Raw

Contributing 🐱

This guide will show you how you can easily contribute to Vue.js Frankfurt. We love recieving contributions from our community and there are many ways to contribute. You can help improve documentation, submit feature requests, propose minor improvements or submit bug reports.

🚨 This guideline is not a strict set of rules you absolutely have to follow, but please use your best judgement when submitting reports. If you would like to contribute to the guidelines themselves, please create a pull request with your proposed changes.

How to contribute 👩‍💻

  1. Fork the repository
  2. Clone your forked repository
  3. Run yarn or npm install (dev mode w/ hot-reload: yarn dev or npm run dev)
  4. Create feature branch
  5. Commit changes
  6. Push to branch
  7. Submit a pull request 🎉

Bug reports 🐛

To submit a bug report, please follow this guide to help maintainers and the community understand your report.

Please follow the bug report template when submitting a bug report.

  • Check if the problem has already been reported - if it has, please add a comment to the existing issue instead of opening a new one.
  • Give your issue a clear and descriptive title
  • Describe how to reproduce the problem step by step
  • Provide examples to demonstrate the steps
  • Describe the problem and explain why it is a problem
  • If you think it helps, include screenshots and animated GIFs where you demonstrate the problem - include steps and the problem itself
  • Include any relevant information (your OS, browser and browser version) in your report

Features/Enhancements ✨

If you would like to submit enhancement suggestions, including new features or improvements, please follow this guide. This will help maintainers and the community understand your suggestion.

Please follow the feature request template when submitting an enhancement.

  • Check if the enhancement has already been submitted - if it has, please add a comment to the enhancement instead of opening a new one.
  • Give your enhancement a clear and descriptive title
  • Describe the suggested enhancement in as much detail as possible
  • Provide examples if relevant
  • Describe the reason for this enhancement and explain why it is useful
  • If you think it will help your report, include related screenshots and animated GIFs
  • Include any additional information or comments you think are relevant

Pull Requests

Please follow the PR template when submitting pull requests.

🚨 Please remember to keep your pull request small in order to make it easy to review - make multiple PRs if you have to