Thanks for your time and interest for contributing to the IVPN CLI project!
As a contributor, here are the guidelines we would like you to follow:
- By contributing to this project you are agreeing to the terms stated in the Contributor License Agreement.
- By contributing to this project, you share your code under the GPLv3 license, as specified in the License file.
- Don't forget to add yourself to the Authors file.
- If you want to report a security problem DO NOT CREATE AN ISSUE, please read our Security Policy on how to submit a security vulnerability.
- When creating a new issue, chose a "Bug report" or "Feature request" template and fill the required information.
- Please describe the steps necessary to reproduce the issue you are running into.
Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the developers might not want to merge into the project.
Follow these steps when you want to submit a pull request:
- Go over installation guides in the README
- Follow instructions in the PR Template
- Update the README file with details of changes if applicable
This project is using Gitflow Workflow.
Naming for branches is made with following structure:
<type>/<issue ID>-<short-summary-or-description>
In case when there is no issue:
<type>/<short-summary-or-description>
Where can be epic, feature, task, bugfix, hotfix or release.
master - The production branch. Clone or fork this repository for the latest copy.
develop - The active development branch. Pull requests should be directed to this branch.
<feature branch> - The feature of fix branch. Pull requests should be made from this branch into develop brach.