Skip to content
This repository has been archived by the owner on Aug 13, 2022. It is now read-only.

Latest commit

 

History

History
47 lines (35 loc) · 3.83 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 3.83 KB
Raw

Introduction

First of all, thank you for considering contributing to WGEF! feel welcome and read the following sections in order to know how to work on something.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Ground Rules

First of all, make sure that you follow Code of Conduct

  • treat others with respect, Everyone can make a valuable contribution to WGEF. We may not always agree, but disagreement is no excuse for poor behavior and poor manners.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.
  • Make sure that you test your code before making a PR.
  • Make sure that your code doesn't break compatibility with other versions.
  • Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
  • You should never, ever report security vulnerabilities or bugs including sensitive information to the bug tracker, or elsewhere in public.
  • when you are unsure, don't be afraid to ask for help! nobody knows everything.
  • when you disagree, consult others - It's important that we resolve disagreements and differing views constructively and with the help of the community and community process.

Reporting bugs or requestig features

YOU SHOULD NEVER, EVER REPORT SECURITY VULNERABILITIES OR BUGS INCLUDING SENSITIVE INFORMATION TO THE BUG TRACKER, OR ELSEWHERE IN PUBLIC, PLEASE CONTACT US PRIVATELY IN DISCORD.

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Contribution that we're looking for

WGEF is an open source project and we love to receive help from our community - you! here are many ways to contribute, from improving the documentation, submitting bug reports and feature requests or writing code which can be used to improve this project.

What we're not looking for

Please, don't use the issue tracker for [support questions]. Check whether the Discord Server can help with your issue.

First Contribution

Unsure where to begin contributing to WGEF? You can start by looking through these beginner and help-wanted issues: Beginner issues - issues which should only require a few lines of code, and a test or two. Help wanted issues - issues which should be a bit more involved than beginner issues. Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

As a side note, if a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.

How to Contribute

  1. Create your own fork of the project
  2. Do the changes in your fork.
  3. If you like the change and think the project could use it:
    • Be sure you have followed the code style for the project provided in .editorconfig.
    • Your submissions are understood to be under the same MIT License that covers the project.
    • Make sure that the changes is indeed working before submitting a PR (Pull Request).
  4. after that submit a pull request and our team will review it.

License

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