CONTRIBUTING.md

Welcome to VPN-Speed-Comparison-Tool contributing guide

Hi 👋, and thank you for finding time to contribute for our project!

Table of Contents:

1. New contributor guide
   • Usefull links
2. Double check
3. How to submit changes
   • Bug-fix, Feature or Vulnerability
   • Use Templates
   • Creating pull request
4. Pretty code
5. Code of Conduct
6. Who???
7. Tl;dr

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

• Finding ways to contribute to open source on GitHub
• Set up Git
• GitHub flow
• Collaborating with pull requests

Here is links which will help start with this project:

Stuff that must be installed before starting: Dependencies
What to write in configuration file before starting the "tool": Configuration
How to setup and run project: Usage

Testing:

Before creating pull request, just double check if your changes did not break something BIG, that can be verified with testing. More information about that can be found in test/README.

How to submit changes:

Bug-fix, Feature or Vulnerability issue:

1. Check if there is an existing issue. If so, contribute to the existing issue.
2. Open a new issue and wait for feedback from us.
3. After receiving feedback, start working on your pull request.

Use Templates:

We have implemented issue templates for BUG, FEATURE, VULNERABILITY. Templates can be found here

Creating pull request

You can create a pull request with template from existing fork, more info can be found here. We will try will try to respond to pull requests as soon as possible.

Code style:

The main idea is to write understandable, efficient and clean code. To make code easy on the eye we use python code formatter Black

Code of Conduct

This project use Code of Conduct adapted version from "Contributor Covenant" so follow it sincerely. By participating, you are expected to uphold this code. Please inform us of non-compliance of this behavior by contacting [email protected].

Who is involved?

This is one of the first Nord Security open source projects, so please shows us some patients and understanding. We are eager to improve and learn how to make this project exceptional ⭐.

Tl;dr

• Links to get started: Usefull links
• Testing: Double check
• Changes to code: Pull requests, and use Black formatting tool.
• Follow the rules: Code of Conduct

Note: We will have an official discussion board and if you have questions. VPN-Speed-Comparison-Tool FAQ