Skip to main content
First and foremost, thank you! We appreciate that you want to contribute to WireGuard Easy. Your time is valuable, and your contributions mean a lot to us.

​
Ways to Contribute

Creating an issue is the simplest form of contributing to a project. There are many ways to contribute, including:
  • Updating or correcting documentation
  • Feature requests
  • Bug reports
  • Code contributions
  • Translations

​
Before You Contribute

By contributing to this project, you agree that:
  • You have authored 100% of the content
  • You have the necessary rights to the content
  • You have received the necessary permissions from your employer to make the contributions (if applicable)
  • The content you contribute may be provided under the Project license(s)
  • If you did not author 100% of the content, the appropriate licenses and copyrights have been added along with any other necessary attribution

​
Showing Support

Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest of the community can use. Don’t have time to contribute? No worries, here are other ways to show your support:

​
Issues

Please only create issues for bug reports or feature requests. Issues discussing other topics may be closed by the project’s maintainers without further explanation.
Do not create issues about bumping dependencies unless a bug has been identified and you can demonstrate that it affects this project.

​
Before Creating an Issue

Please try to determine if the issue is caused by an underlying library, and if so, create the issue there. Try to follow these guidelines:
  • Avoid creating issues for implementation help - Ask implementation-related questions on Stack Overflow instead
  • Investigate the issue - Search for existing issues (open or closed) that address the problem
  • Check the documentation - Review the docs for your version and the README
  • Create the issue in the appropriate repository

​
Creating an Issue

Use the issue templates to provide the necessary information. Issues which do not use these templates are not worked on and closed.
Please be as descriptive as possible when creating an issue. Include:
  • Description: What is the bug you’re experiencing? How are you using this app?
  • OS: What operating system are you on?
  • Version: Note the version of WireGuard Easy you’re using
  • Error messages: Paste any error messages into the issue or a gist
  • Extensions, plugins, helpers, etc: List any extensions you’re using (if applicable)

​
Help Us to Help You

Remember that maintainers are here to help, but not to make guesses about what you need help with:
  • Whatever bug or issue you’re experiencing, assume that it will not be as obvious to the maintainers as it is to you
  • Spell it out completely. Maintainers need to think about all potential use cases
  • Explain how you’re using the application so that maintainers can make that connection and solve the issue
It can’t be understated how frustrating and draining it can be to maintainers to have to ask clarifying questions on the most basic things before debugging can even start. Please make the best use of everyone’s time by providing this information upfront.

​
Next Steps

​
Tips for Creating Better Issues

The following resources can help you be the most effective contributor: At the very least, please try to:
  • Use backticks to wrap code for proper formatting
  • When applicable, use syntax highlighting by adding the correct language name after the first “code fence”

Build docs developers (and LLMs) love

Get started for freeTalk to us