Skip to content

Commit

Permalink
Merge pull request #2 from ViktorJp/main
Browse files Browse the repository at this point in the history
Sync
  • Loading branch information
ViktorJp authored Feb 22, 2024
2 parents 810e105 + ce30d34 commit 13435fb
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 3,574 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/Check pull request source branch.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Check pull request source branch
on:
pull_request_target:
types:
- opened
- reopened
- synchronize
- edited
jobs:
check-branches:
runs-on: ubuntu-latest
steps:
- name: Check branches
run: |
if [ ${{ github.head_ref }} != "develop" ] && [ ${{ github.base_ref }} == "main" ]; then
echo "Merge requests to main branch are only allowed from dev branch."
exit 1
fi
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Contributing to VPNMON-R3

We're thrilled that you're interested in contributing to VPNMON-R3! This document provides a set of guidelines for contributing to VPNMON-R3. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

VPNMON-R3 is licensed under the Unlicense, a license with no conditions whatsoever which dedicates works to the public domain.

****How Can I Contribute?****
For those wishing to contribute to VPNMON-R3, please make your mods to the **"vpnmon-r3.sh"** file under the "develop" branch. For more info, please see below:

------

**Reporting Bugs**
* Use a clear and descriptive title for the issue to identify the problem.
* Describe the exact steps which reproduce the problem in as much detail as possible.
* Provide specific examples screenshots or logs to demonstrate the steps

**Suggesting Enhancements**
* Use a clear and descriptive title for the issue to identify the suggestion.
* Provide a step-by-step description of the suggested enhancement in as much detail as possible.

**Your First Code Contribution**
* Pull requests are the method for submitting changes. Here's the general process:
* Fork the repository.
* Create a new branch in your fork (git checkout -b feature/my-new-feature).
* Make your changes.
* Commit your changes (git commit -am 'Add some feature').
* Push to the branch (git push origin feature/my-new-feature).
* Create a new Pull Request.

**Pull Request Guidelines**
* Write clear and concise commit messages.
* Include links to existing BUGS or REQs when possible.
* Include screenshots and logs whenever possible.
* End all files with a newline.

**Documentation Styleguide**
* Keep language simple and clear.

**More Questions?**
* Feel free to ask for help if you need it, either via issues or through the provided contact owner @VictorJp
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 13435fb

Please sign in to comment.