Bauke/tildes-issue-log
Bauke
/
tildes-issue-log
Archived
1
Fork 0
Code Releases Activity

Add contributing and building sections to README

This commit is contained in:
Bauke 2018-06-25 00:56:52 +02:00
parent 2f51b0c643
commit cfed026def
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -4,6 +4,26 @@
* [May](https://gitlab.com/Bauke/tildes-issue-log/tree/master/2018/May/post.md)
## Contributing
If you'd like to write a highlight section about a feature, please do! I'm not a writer by any means and would love to have other people write these instead. If you're not familiar with the Git workflow you can always [private message me](https://tildes.net/user/Bauke/new_message) with what you've written and I'll add your section for you, crediting your Tildes profile. If you'd like to learn Git, you can find tons of guides online. [Here's](https://try.github.io/) an excellent one.
## Building
Building guidelines will be added if the response to this project is good, since it's pretty barebones right now.
If you'd like to build the issue table and/or statistics yourself you can follow these steps.
You'll need [Node JS](https://nodejs.org/) and [Yarn](https://yarnpkg.com/). You *can* use NPM however I don't. You probably know what you're doing though at that point.
* Clone the repository
* SSH: `git clone git@gitlab.com:Bauke/tildes-issue-log.git`
* HTTPS: `git clone https://gitlab.com/Bauke/tildes-issue-log.git`
* Change into the directory: `cd tildes-issue-log`
* Install the dependencies: `yarn`
* Create a `config.json` file from the sample config, including a [personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) from GitLab. **config.json is gitignored however make sure you don't publish your token somewhere on accident.**
* Run `yarn start` to download the issues from the current month we're in.
This will create a new directory like `2018/August` and have 2 folders and 3 markdown files.
The folders are for issues both opened or closed during that month and are gitignored. `post.md` will be the same as `template.md` unless it already exists. `table.md` will be the issue table. `statistics.md` will be the statistics.
If you're working on the generation process you can run `yarn nodl` to skip the downloading phase, this will only generate `table.md` and `statistics.md`. This way you don't have to wait several seconds for the GitLab API to respond.