Skip to content

Commit d367466

Browse files
committed
Add first version of the README template for Github
Why: * The purpose of having a template is help setting up a README. Sometimes we don't know what to write, or how to structure it. It also helps in uniformizing our READMEs across projects. It probably won't fit every use case, but I believe it will fit most. It's not written in stone, so changes will always be welcome. This change addresses the need by: * Adding a template to use in all Github projects.
1 parent c6131af commit d367466

File tree

3 files changed

+103
-0
lines changed

3 files changed

+103
-0
lines changed

github/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,8 @@ Working on Issues/Pull Requests
2424
* Submit a Pull Request with the fix.
2525
* If your Pull Requests fixes one or more issues, link to them in the discussion.
2626
* Tag a person (or [team](https://github.com/orgs/subvisual/teams)) if you need their input specifically.
27+
28+
Creating a repository
29+
-----------------------
30+
31+
* If you are creating a Github repository, use the [templates](templates).

github/templates/README.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
[trello]: https://trello.com/whatever
2+
[build-page]: https://semaphore.com/whatever
3+
[production]: https://link.to.production/
4+
5+
PROJECT NAME
6+
============
7+
8+
Put the build badges here.
9+
10+
* [Trello][trello]
11+
* [Build Page][build-page]
12+
* [Production][production]
13+
* ...
14+
15+
Short project description. You can use the client's pitch. No more than ten lines.
16+
17+
**Table of Contents**
18+
19+
* [Setup](#setup)
20+
* [Development](#development)
21+
* [Deployment](#deployment)
22+
* [More Sections](#more-sections)
23+
* [Contribution Guidelines](#contribution-guidelines)
24+
* [Resources](#resources)
25+
* [Contacts](#contacts)
26+
27+
Setup
28+
-----
29+
30+
A set of instructions to install the project. It can start with a list of dependencies, like databases, and finish with the instructions. For instance:
31+
32+
First clone the repository to your file system:
33+
34+
```
35+
git clone git@github.com:subvisual/guides.git
36+
```
37+
38+
After, run the setup script:
39+
40+
```
41+
bin/setup
42+
```
43+
44+
To finish, open the file `.env` and replace the values accordingly.
45+
46+
Development
47+
-----------
48+
49+
A set of instructions to run the project in development. For instance:
50+
51+
To start your development environment run:
52+
53+
```
54+
bin/server
55+
```
56+
57+
This will start the node application, Redis, and Gulp.
58+
ProjectName uses Gulp to watch and compile frontend assets.
59+
To build the assets only once, not watching for changes, run:
60+
61+
```
62+
npm run build
63+
```
64+
65+
Deployment
66+
----------
67+
68+
Deploys can be manual or automatic. In both cases, write a short explanation about how it works: if the process is manual write the steps necessary to accomplish it; if the process is automatic, link to the page to consult the deployment status. Take the following as an example:
69+
70+
To deploy the app run `bin/deploy`
71+
72+
More Sections
73+
-------------
74+
75+
This section is just a placeholder. You can replace it with any section or sections. Here you can write everything you feel the reader should know should about the project. This is the place to document other commands that are available to the user, or instructions on how to do something that's manual
76+
77+
Contribution Guidelines
78+
-----------------------
79+
80+
Contributions must follow [Subvisual's guides](https://github.com/subvisual/guides).
81+
82+
Resources
83+
---------
84+
85+
This section should list every online resource that is relevante to the project. For instance:
86+
87+
* Link to spec file on Goole Drive
88+
* Link to Invision files.
89+
* ...
90+
91+
About
92+
-----
93+
94+
ProjectName is maintained by [Subvisual](http://subvisual.co).
95+
96+
[![Subvisual](subvisual_logo_with_name.png)](http://subvisual.co)
97+
98+
If you need to contact the maintainer use [this](https://trello.com/b/svB6ZSce/areas-of-responsability-dris) trello board, or reach out to <a href="mailto:contact@subvisual.co">Some One</a> if you don't have access.
13.8 KB
Loading

0 commit comments

Comments
 (0)