Skip to content

Commit af43238

Browse files
authored
Merge pull request #24 from BeAPI/branding
Branding
2 parents 59f50d4 + 7671044 commit af43238

8 files changed

+838
-17
lines changed

.github/CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Thanks for contributing !
2+
3+
# Getting Started
4+
5+
* Make sure you have a [GitHub account](https://github.com/signup/free).
6+
* Check if your issue has already been discussed (or even fixed) earlier. You can [search for existing issues](../../../issues?q=is%3Aissue).
7+
* Assuming it does not already exist, [create a new issue](../../../issues/new).
8+
* Clearly describe the issue. In case you want to report a bug, include steps to reproduce it.
9+
* Make sure you fill in the requested details to provide as much information as possible.
10+
* Fork the repository on GitHub.
11+
12+
# Making Changes
13+
14+
* Create a topic branch from where you want to base your work.
15+
* This is usually the `master` branch.
16+
* Only target release branches if you are certain your fix must be on that branch.
17+
* To quickly create a topic branch based on the `master` branch:
18+
* `git checkout -b issue/{issue-number} master`
19+
* a good example is `issue/7`
20+
* Make commits of logical units and that messages are helpful.
21+
22+
# Submitting Changes
23+
24+
* Push your changes to the according topic branch in your fork of the repository.
25+
* [Create a pull request](../../../compare) to our repository.
26+
* Wait for feedback. The team looks at pull requests on a regular basis.
27+
28+
# License
29+
30+
By contributing code, you grant its use under the [GPLv3 or Later license](../LICENSE.md).

.github/ISSUE_TEMPLATE.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
Thanks for contributing !
3+
4+
Please note:
5+
- These comments won't show up when you submit your issue.
6+
- Please choose a descriptive title, ex. : "Can't show if xx module is activated.".
7+
- Try to provide as many details as possible on the below list.
8+
- If requesting a new feature, please explain why you'd like to see it added.
9+
-->
10+
11+
#### Version information
12+
13+
* Tool version :
14+
15+
#### Steps to reproduce
16+
17+
1.
18+
2.
19+
3.
20+
21+
#### What was expected
22+
23+
24+
#### What happened instead

.github/PULL_REQUEST_TEMPLATE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!--
2+
Thanks for contributing !
3+
4+
Please note :
5+
- These comments won't show up when you submit the pull request.
6+
- Please provide tests, if you can.
7+
-->
8+
9+
This pull request fixes issue #{id}.
10+
11+
It will apply the following changes :
12+
13+
*
14+
*
15+
*

CHANGELOG.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog ##
2+
3+
## 1.4.0
4+
- Refactor readme
5+
- Branding
6+
- Add readme's installation section and usage
7+
8+
## 1.1
9+
* Implement recommended/required for each config/module
10+
* Improve test config value
11+
12+
## 1.0
13+
* Initial release

0 commit comments

Comments
 (0)