Skip to content

Commit

Permalink
Initialize .github files (Path-Check#48)
Browse files Browse the repository at this point in the history
* Add contribution guide
* Initialize .github files
Helping others get started
  • Loading branch information
penrods authored and vitorpamplona committed Mar 20, 2020
1 parent cfecd23 commit 1533198
Show file tree
Hide file tree
Showing 4 changed files with 167 additions and 0 deletions.
68 changes: 68 additions & 0 deletions .github/.github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# How to contribute

We welcome participation in open project. We want to make it as easy as
possible for people to work together, so please follow these guidelines to
prepare and submit a pull request.

## How to prepare

* You need a Github account. You can [create one](https://github.com/signup/free)
for free.
* Submit an [Issue](https://github.com/tripleblind/mobileapp/issues) against
the repo to describe the idea or problem if there is not one yet.
* Describe a bug by including steps to reproduce and earliest version you
know is affected.
* Describe a new feature with as much detail as possible.
* Fork the repository on GitHub and clone locally (see how to [fork a repo](https://help.github.com/articles/fork-a-repo/)).

## Make Changes

1. Create a branch based on the `develop` branch. Name the branch in the
format: "flast/description", where "flast" is your first initial + last
name, and "description" is as simple description of the work being done.
For example, if Steve Penrod wants to add a new icon a branch name could
"spenrod/new-icon".
2. Stick to the coding style and patterns that are used already.
3. Document code! Comments are good. More comments are better. :)
4. Make commits as you desire. Ultimately they will be squashed, so make
notes to yourself.
5. Once you have committed everything and are done with your branch, rebase
your code against `develop` by:
- Checkout the `develop` branch and make sure it is up-to-date.
- Checkout your branch and rebase it against `develop`.
- Resolve any conflicts locally.
- Force your push since the historical base has changed.
- Specific commands:
```
git checkout develop
git fetch
git reset --hard origin/develop
git checkout <your_branch_name>
git rebase develop
git push -f
```
6. Finally [create a Pull Request (PR) on Github](https://help.github.com/articles/using-pull-requests/)
for review and merging.

**Note**: Even if you have write access, do not work directly on `master` or
push directly to `develop`! All work is done against `develop`, reviewed and
merged via PRs, and ultimately `develop` gets merged into `master` for tagged
code releases.

## Submit Changes

* Push your changes to a topic branch in your fork of the repository.
* Open a pull request to the original repository and choose the `develop`
_Advanced users may install the `hub` gem and use the [`hub pull-request` command](https://github.com/defunkt/hub#git-pull-request)._
* If not done in commit messages (which you really should do), reference and
update your issue with the code changes. But _please do not close the issue
yourself_.
* A team member will review the pull request, request change or approve and
merge into the `develop` branch.

# Additional Resources

* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
* [Read the Issue Guidelines by @necolas](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md) for more details

26 changes: 26 additions & 0 deletions .github/.github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Submitting an Issue

When submitting an Issue against Privte Kit, please follow these guidelines to help us help you.

## Version

* Type of phone: Android / iPhone
* OS Version:
* Model: e.g. Samsung Galaxy S8

## Steps to reproduce

Be as detailed as possible

## Expected Behavior

Example:

* When I click `Stop Logging` I am taken to the `Import` screen. Expect to
go back to the Welcome greeting.

## Upload any files to the Issue useful in helping us to investigate

Please ensure you upload any relevant files - such as screenshots - which
will aid in investigating and fixing.

5 changes: 5 additions & 0 deletions .github/.github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Description
Description of what the PR does, includeing a fixed issue with Resolves #{issue number}

## How to test
Description of how to validate or test this PR
68 changes: 68 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# How to contribute

We welcome participation in open project. We want to make it as easy as
possible for people to work together, so please follow these guidelines to
prepare and submit a pull request.

## How to prepare

* You need a Github account. You can [create one](https://github.com/signup/free)
for free.
* Submit an [Issue](https://github.com/tripleblind/mobileapp/issues) against
the repo to describe the idea or problem if there is not one yet.
* Describe a bug by including steps to reproduce and earliest version you
know is affected.
* Describe a new feature with as much detail as possible.
* Fork the repository on GitHub and clone locally (see how to [fork a repo](https://help.github.com/articles/fork-a-repo/)).

## Make Changes

1. Create a branch based on the `develop` branch. Name the branch in the
format: "flast/description", where "flast" is your first initial + last
name, and "description" is as simple description of the work being done.
For example, if Steve Penrod wants to add a new icon a branch name could
"spenrod/new-icon".
2. Stick to the coding style and patterns that are used already.
3. Document code! Comments are good. More comments are better. :)
4. Make commits as you desire. Ultimately they will be squashed, so make
notes to yourself.
5. Once you have committed everything and are done with your branch, rebase
your code against `develop` by:
- Checkout the `develop` branch and make sure it is up-to-date.
- Checkout your branch and rebase it against `develop`.
- Resolve any conflicts locally.
- Force your push since the historical base has changed.
- Specific commands:
```
git checkout develop
git fetch
git reset --hard origin/develop
git checkout <your_branch_name>
git rebase develop
git push -f
```
6. Finally [create a Pull Request (PR) on Github](https://help.github.com/articles/using-pull-requests/)
for review and merging.

**Note**: Even if you have write access, do not work directly on `master` or
push directly to `develop`! All work is done against `develop`, reviewed and
merged via PRs, and ultimately `develop` gets merged into `master` for tagged
code releases.

## Submit Changes

* Push your changes to a topic branch in your fork of the repository.
* Open a pull request to the original repository and choose the `develop`
_Advanced users may install the `hub` gem and use the [`hub pull-request` command](https://github.com/defunkt/hub#git-pull-request)._
* If not done in commit messages (which you really should do), reference and
update your issue with the code changes. But _please do not close the issue
yourself_.
* A team member will review the pull request, request change or approve and
merge into the `develop` branch.

# Additional Resources

* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
* [Read the Issue Guidelines by @necolas](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md) for more details

0 comments on commit 1533198

Please sign in to comment.