Skip to content

Commit c33800c

Browse files
ui2codeui2code
committed
add: readme and contributing
1 parent 90569a4 commit c33800c

9 files changed

Lines changed: 188 additions & 24 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,21 @@
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+
> Setting guidelines for [repository contributors](https://help.github.com/articles/setting-guidelines-for-repository-contributors/).
7+
8+
> 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).
9+
610
## Templates
711

812
### README
913

10-
- [Default](templates/readme/default.md)
11-
- []()
14+
- [default](templates/readme/default.md)
15+
- [gh-pages](templates/readme/gh-pages.md)
16+
- [gh-pages](templates/readme/app.md)
1217

18+
### CONTRIBUTING
1319

14-
> 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).
20+
- []()
1521

1622
### ISSUE_TEMPLATE
1723

@@ -23,6 +29,10 @@
2329
- []()
2430
- []()
2531

32+
## References
33+
34+
-
35+
2636
## Contributing
2737

2838
- Fork it!

‎templates/contributing/CONTRIBUTING.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributors Guide
2+
3+
Please read and understand the contribution guide before creating an issue or pull request.
4+
5+
## Etiquette
6+
7+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers. It would be extremely unfair for them to suffer abuse or anger for their hard work.
8+
9+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the world that developers are civilized and selfless people.
10+
11+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
12+
13+
## Viability
14+
15+
When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many developers, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.
16+
17+
## Procedure
18+
19+
Before filing an issue:
20+
21+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
22+
- Check to make sure your feature suggestion isn't already present within the project.
23+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
24+
- Check the pull requests tab to ensure that the feature isn't already in progress.
25+
26+
Before submitting a pull request:
27+
28+
- Ensure that your submission is [viable](#viability) for the project.
29+
- Check the codebase to ensure that your feature doesn't already exist.
30+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
31+
32+
## Requirements
33+
34+
If the project maintainer has any additional requirements, you will find them listed here.
35+
36+
- No additional requirements.

‎templates/issue/ISSUE_TEMPLATE.md‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1-
# Please follow the general troubleshooting steps first:
1+
Please prefix your issue with one of the following: **[BUG]** **[PROPOSAL]** **[QUESTION]**.
22

3-
- [ ] Ran ?
4-
- [ ] Ran ?
5-
- [ ] If you're seeing permission errors ?
3+
**In raising this issue, I confirm the following (please check boxes):**
64

7-
<!-- You can erase any parts of this template not applicable to your Issue. -->
5+
- [ ] I have read and understood the [contributors guide]().
6+
- [ ] I have checked that the bug-fix I am reporting can be replicated, or that the feature I am suggesting isn't already present.
7+
- [ ] I have checked the pull requests tab for existing solutions/implementations to my issue/suggestion.
88

9-
### Bug reports:
9+
**My familiarity with the project is as follows (check one):**
1010

11-
Please replace this line with a brief summary of your issue **AND** if reporting a build issue include the link from:
11+
- [ ] I have never used the project.
12+
- [ ] I have used the project briefly.
13+
- [ ] I have used the project extensively, but have not contributed previously.
14+
- [ ] I am an active contributor to the project.
1215

13-
### Features:
16+
**If the project maintainer has any additional requirements, they will be listed here.**
1417

15-
**Please note by far the quickest way to get a new feature is to file a Pull Request.**
18+
- No additional requirements.
1619

17-
We will consider your request but it may be closed if it's something we're not actively planning to work on.
20+
---
21+
22+
{issue content here}

‎templates/pull-request/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
1-
### All Submissions:
1+
Please prefix your pull request with one of the following: **[FEATURE]** **[FIX]** **[IMPROVEMENT]**.
22

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?
3+
**In raising this pull request, I confirm the following (please check boxes):**
54

6-
<!-- You can erase any parts of this template not applicable to your Pull Request. -->
5+
- [ ] I have read and understood the [contributors guide]().
6+
- [ ] I have checked that another pull request for this purpose does not exist.
7+
- [ ] I have considered, and confirmed that this submission will be valuable to others.
8+
- [ ] I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
9+
- [ ] I give this submission freely, and claim no ownership to its content.
710

8-
### New Feature Submissions:
11+
**My familiarity with the project is as follows (check one):**
912

10-
1. [ ] Does your submission pass tests?
11-
2. [ ] Have you lint your code locally prior to submission?
13+
- [ ] I have never used the project.
14+
- [ ] I have used the project briefly.
15+
- [ ] I have used the project extensively, but have not contributed previously.
16+
- [ ] I am an active contributor to the project.
1217

13-
### Changes to Core Features:
18+
**If the project maintainer has any additional requirements, they will be listed here.**
1419

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?
20+
- No additional requirements.
21+
22+
---
23+
24+
{pull request content here}

‎templates/readme/app.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# App Name as Headline
2+
3+
**App Name** is an app for things. Short description here.
4+
5+
#### Screenshot
6+
![Screenshot Android](http://url/screenshot-appname-android.png "screenshot Android")
7+
8+
![Screenshot iOS](http://url/screenshot-appname-ios.png "screenshot iOS")
9+
10+
#### App Stores
11+
<!-- edit this image location -->
12+
[![Get it on Google Play](https://raw.github.com/repat/README-template/master/googleplay.png)](https://play.google.com/store/apps/details?id=com.package.path)
13+
14+
<!-- edit this image location -->
15+
[![Download on the AppStore](https://raw.github.com/repat/README-template/master/appstore.png)](https://itunes.apple.com/app/id123456)
16+
17+
#### QR Market Links
18+
![QR-Code Android](http://url/qrcode-appname-android.png)
19+
20+
![QR-Code iOS](http://url/qrcode-appname-ios.png)
21+
22+
## Tests
23+
#### Works on
24+
* Devices it works with
25+
26+
#### Does not work on
27+
* Devices it doesn't work with
28+
29+
## Contributors
30+
### Artwork
31+
* Any credit to artists(music,images,...)
32+
33+
### Contributors on GitHub
34+
* [Contributors](https://github.com/username/appname/graphs/contributors)
35+
36+
### Translations
37+
* [Transifex](https://www.transifex.com/projects/p/appname/)
38+
39+
## Permissions
40+
* Any permissions needed by the app
41+
42+
## Version
43+
* Version X.Y
44+
45+
## How-to use
46+
47+
48+
## Contact
49+
#### Developer/Company
50+
* Homepage:
51+
* e-mail:
52+
* Twitter: [@twitterhandle](https://twitter.com/twitterhandle "twitterhandle on twitter")
53+
* other communication/social media
54+
55+
## License
56+
57+
[MIT license](http://[user].mit-license.org/) © [name]

‎templates/readme/appstore.png‎

3.31 KB
Loading

‎templates/readme/gh-pages.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# username.github.io
2+
3+
**username.github.io** is my personal/project website. You will most likely find it under [domain.tld](http://domain.tld).
4+
5+
## Domains
6+
* see [CNAME](https://github.com/username/username.github.io/blob/master/CNAME) file
7+
8+
## Technology
9+
* CSS frameworks, e.g. BootStrap
10+
* Themes
11+
* JS frameworks, e.g. jQuery
12+
* IconSets, e.g. Glyphicons
13+
* [GitHub Pages](http://pages.github.com/)
14+
* [robots.txt](https://github.com/username/username.github.io/blob/master/robots.txt)
15+
* [Google Webmaster](http://www.google.com/webmasters/)
16+
* [Analytics Software](http://link-to-e.g.-google-analytics)
17+
18+
## Contact
19+
#### Developer/Projects spokesman
20+
* Homepage:
21+
* e-mail:
22+
* Twitter: [@twitterhandle](https://twitter.com/twitterhandle "twitterhandle on twitter")
23+
* other communication/social media
24+
25+
## License
26+
27+
[MIT license](http://[user].mit-license.org/) © [name]

‎templates/readme/googleplay.png‎

7.98 KB
Loading

‎templates/readme/script.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Script Name as Headline
2+
3+
**Script Name** is a script for things. The usage is explained like this:
4+
5+
```
6+
$ ./script parameter1 .. parameterN
7+
Output
8+
$
9+
```
10+
## Version
11+
* Version X.Y
12+
13+
## Contact
14+
#### Developer/Company
15+
* Homepage:
16+
* e-mail:
17+
* Twitter: [@twitterhandle](https://twitter.com/twitterhandle "twitterhandle on twitter")
18+
* other communication/social media
19+
20+
## License
21+
22+
[MIT license](http://[user].mit-license.org/) © [name]

0 commit comments

Comments
 (0)