Skip to content

Commit 90569a4

Browse files
committed
update: readme
1 parent 4ed6d80 commit 90569a4

4 files changed

Lines changed: 68 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,25 @@
33
[![licence mit](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](http://hemersonvianna.mit-license.org/)
44
[![issues](https://img.shields.io/github/issues/brazilian-dev/github-templates.svg?style=flat-square)](https://github.com/brazilian-dev/github-templates/issues)
55

6+
## Templates
7+
8+
### README
9+
10+
- [Default](templates/readme/default.md)
11+
- []()
12+
13+
614
> GitHub listened and now we're able to [create templates for issues and pull requests](https://github.com/blog/2111-issue-and-pull-request-templates).
715
8-
## Issues `ISSUE_TEMPLATE.md`
16+
### ISSUE_TEMPLATE
917

18+
- []()
19+
- []()
1020

11-
## Pull Requests `PULL_REQUEST_TEMPLATE.md`
21+
### PULL_REQUEST_TEMPLATE
1222

23+
- []()
24+
- []()
1325

1426
## Contributing
1527

templates/issue/ISSUE_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Please follow the general troubleshooting steps first:
2+
3+
- [ ] Ran ?
4+
- [ ] Ran ?
5+
- [ ] If you're seeing permission errors ?
6+
7+
<!-- You can erase any parts of this template not applicable to your Issue. -->
8+
9+
### Bug reports:
10+
11+
Please replace this line with a brief summary of your issue **AND** if reporting a build issue include the link from:
12+
13+
### Features:
14+
15+
**Please note by far the quickest way to get a new feature is to file a Pull Request.**
16+
17+
We will consider your request but it may be closed if it's something we're not actively planning to work on.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### All Submissions:
2+
3+
* [ ] Have you followed the guidelines in our Contributing document?
4+
* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change?
5+
6+
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
7+
8+
### New Feature Submissions:
9+
10+
1. [ ] Does your submission pass tests?
11+
2. [ ] Have you lint your code locally prior to submission?
12+
13+
### Changes to Core Features:
14+
15+
* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
16+
* [ ] Have you written new tests for your core changes, as applicable?
17+
* [ ] Have you successfully ran tests with your changes locally?

templates/readme/default.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Title
2+
3+
[![licence mit](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](http://[user].mit-license.org/)
4+
[![issues](https://img.shields.io/github/issues/[user]/[repo].svg?style=flat-square)](https://github.com/[user]/[repo]/issues)
5+
6+
## Contributing
7+
8+
- Fork it!
9+
- Create your feature branch: `git checkout -b my-new-feature`
10+
- Commit your changes: `git commit -m 'Add some feature'`
11+
- Push to the branch: `git push origin my-new-feature`
12+
- Submit a pull request
13+
14+
## Log
15+
16+
Check [Releases](https://github.com/[user]/[repo]/releases) for detailed changelog.
17+
18+
## License
19+
20+
[MIT license](http://[user].mit-license.org/) © [name]

0 commit comments

Comments
 (0)