Skip to content

Commit

Permalink
Merge pull request #24 from BeAPI/branding
Browse files Browse the repository at this point in the history
Branding
  • Loading branch information
herewithme authored Sep 7, 2018
2 parents 59f50d4 + 7671044 commit af43238
Show file tree
Hide file tree
Showing 8 changed files with 838 additions and 17 deletions.
30 changes: 30 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Thanks for contributing !

# Getting Started

* Make sure you have a [GitHub account](https://github.com/signup/free).
* Check if your issue has already been discussed (or even fixed) earlier. You can [search for existing issues](../../../issues?q=is%3Aissue).
* Assuming it does not already exist, [create a new issue](../../../issues/new).
* Clearly describe the issue. In case you want to report a bug, include steps to reproduce it.
* Make sure you fill in the requested details to provide as much information as possible.
* Fork the repository on GitHub.

# Making Changes

* Create a topic branch from where you want to base your work.
* This is usually the `master` branch.
* Only target release branches if you are certain your fix must be on that branch.
* To quickly create a topic branch based on the `master` branch:
* `git checkout -b issue/{issue-number} master`
* a good example is `issue/7`
* Make commits of logical units and that messages are helpful.

# Submitting Changes

* Push your changes to the according topic branch in your fork of the repository.
* [Create a pull request](../../../compare) to our repository.
* Wait for feedback. The team looks at pull requests on a regular basis.

# License

By contributing code, you grant its use under the [GPLv3 or Later license](../LICENSE.md).
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--
Thanks for contributing !
Please note:
- These comments won't show up when you submit your issue.
- Please choose a descriptive title, ex. : "Can't show if xx module is activated.".
- Try to provide as many details as possible on the below list.
- If requesting a new feature, please explain why you'd like to see it added.
-->

#### Version information

* Tool version :

#### Steps to reproduce

1.
2.
3.

#### What was expected


#### What happened instead
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!--
Thanks for contributing !
Please note :
- These comments won't show up when you submit the pull request.
- Please provide tests, if you can.
-->

This pull request fixes issue #{id}.

It will apply the following changes :

*
*
*
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Changelog ##

## 1.4.0
- Refactor readme
- Branding
- Add readme's installation section and usage

## 1.1
* Implement recommended/required for each config/module
* Improve test config value

## 1.0
* Initial release
Loading

0 comments on commit af43238

Please sign in to comment.