Thank you for investing your time in contributing to this project! Any contributions you make have a chance of reflecting in the actual Package on Pub.dev, and brightens up my day. :)
Make sure you go through the API Documentation first!
-
Ensure you have Python 3 installed.
-
Fork the project repository.
-
Clone the forked repository by running
git clone <forked-repository-git-url>. -
Navigate to your local repository by running
cd auto_vpn_connect. -
Pull the latest changes from upstream into your local repository by running
git pull. -
Create a new branch by running
git checkout -b <new-branch-name>. -
Make changes in your local repository to make the contribution you want.
-
Add relevant tests (if any) for the contribution you made to
./test/folder and an appropriate subfolder. -
Commit your changes and push them to your local repository by running
git commit -am "my-commit-message" && git push origin <new-branch-name>. -
Create a pull request on the original repository from your fork and wait for me to review (and hopefully merge) it. :)
- Fork Project -> Create new Branch
- For each contribution in mind,
- -> Develop Data Models
- -> Develop Service Layer
- -> Test
- -> Ensure Documentation is sufficient
- -> Commit
- Create Pull Request
If you spot a problem or bug with the package, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information.
-
Contributions are welcome on GitHub. Please ensure all the tests are running before pushing your changes. Write your own tests too!
-
File any issues or feature requests here, or help me resolve existing ones.