Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
58 changed files
with
2,058 additions
and
1,178 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Contributing | ||
|
||
## Creating Issues | ||
|
||
To file bug reports and feature suggestions, use the [issues page](../../issues?q=is%3Aissue). | ||
|
||
1. Make sure the issue has not been filed before. | ||
|
||
1. [Create a new Issue](../../issues/new) by filling out the form. | ||
|
||
1. If an issue requires more information and receives no further input, it will be closed. | ||
|
||
|
||
## Creating Pull Requests | ||
|
||
To create pull requests, use the [Pull Requests page](../../pulls). | ||
|
||
1. [Create a new Issue](#creating-issues) describing the Bug or Feature you are addressing, to let others know you are working on it. | ||
|
||
1. If a related issue exists, add a comment to let others know that you'll submit a pull request. | ||
|
||
1. [Create a new Pull Request](../../pulls/new) by filling out the form. | ||
|
||
|
||
### Setup | ||
|
||
1. Fork the repository. | ||
1. Clone your fork. | ||
1. Make a branch for your change. | ||
1. Run `npm install`. | ||
|
||
## Commit Message | ||
|
||
Use the AngularJS commit message format: | ||
|
||
``` | ||
type(scope): subject | ||
``` | ||
|
||
#### type | ||
- `feat` New feature | ||
- `fix` A bugfix | ||
- `refactor` Code changes which are neither bugfix nor feature | ||
- `docs`: Documentation changes | ||
- `test`: New tests or changes to existing tests | ||
- `chore`: Changes to tooling or library changes | ||
|
||
#### scope | ||
The context of the changes, e.g. `preferences-window` or `compiler`. Use consistent names. | ||
|
||
#### subject | ||
A **brief, yet descriptive** description of the changes, using the following format: | ||
|
||
- present tense | ||
- lowercase | ||
- no period at the end | ||
- describe what the commit does | ||
- reference to issues via their id – e.g. `(#1337)` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
resources/modules/** | ||
resources/** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Contributing | ||
|
||
## <a name="creating-issues"/></a> Creating Issues | ||
|
||
To file bug reports and feature suggestions, use the ["Issues"](https://github.com/sidneys/pb-for-desktop/issues?q=is%3Aissue) page. | ||
|
||
1. Make sure the issue has not been filed before. | ||
1. Create a new issue by filling out [the issue form](https://github.com/sidneys/pb-for-desktop/issues/new). | ||
1. If an issue requires more information and receives no further input, it will be closed. | ||
|
||
|
||
## Creating Pull Requests | ||
|
||
To create pull requests, use the ["Pull Requests"](https://github.com/sidneys/pb-for-desktop/pulls) page. | ||
|
||
1. [Create a new Issue](#creating-issues) describing the Bug or Feature you are addressing, to let others know you are working on it. | ||
1. If a related issue exists, add a comment to let others know that you'll submit a pull request. | ||
1. Create a new pull request by filling out [the pull request form](https://github.com/sidneys/pb-for-desktop/pulls/compare). | ||
|
||
|
||
### Setup | ||
|
||
1. Fork the repository. | ||
1. Clone your fork. | ||
1. Make a branch for your change. | ||
1. Run `npm install`. | ||
|
||
## Commit Message | ||
|
||
Use the AngularJS commit message format: | ||
|
||
``` | ||
type(scope): subject | ||
``` | ||
|
||
#### type | ||
- `feat` New feature | ||
- `fix` A bugfix | ||
- `refactor` Code changes which are neither bugfix nor feature | ||
- `docs`: Documentation changes | ||
- `test`: New tests or changes to existing tests | ||
- `chore`: Changes to tooling or library changes | ||
|
||
#### scope | ||
The context of the changes, e.g. `preferences-window` or `compiler`. Use consistent names. | ||
|
||
#### subject | ||
A **brief, yet descriptive** description of the changes, using the following format: | ||
|
||
- present tense | ||
- lowercase | ||
- no period at the end | ||
- describe what the commit does | ||
- reference to issues via their id – e.g. `(#1337)` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{ | ||
"3.1.2": { | ||
"🍾 features": [ | ||
"Adds new build & release system" | ||
], | ||
"📒 documentation": [ | ||
"Updated screenshots", | ||
"Add developer templates" | ||
], | ||
"👷 internals": [ | ||
"Automates change log generation", | ||
"Upgrades Electron to v1.7.4", | ||
"Upgrades build system", | ||
"Upgrades dependencies" | ||
] | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## 3.1.2 | ||
|
||
#### 🍾 Features | ||
|
||
- Adds new build & release system | ||
|
||
#### 📒 Documentation | ||
|
||
- Updated screenshots | ||
- Add developer templates | ||
|
||
#### 👷 Internals | ||
|
||
- Automates change log generation | ||
- Upgrades Electron to v1.7.4 | ||
- Upgrades build system | ||
- Upgrades dependencies |
Oops, something went wrong.