Skip to content

Commit b69599d

Browse files
committed
add interface screenshot
Signed-off-by: vsoch <vsochat@stanford.edu>
1 parent 5347731 commit b69599d

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Good First Issues
22

3+
![img/good-first-issues.png](img/good-first-issues.png)
4+
35
A GitHub action to generate a web interface with an updated set of issues. This means that:
46

57
- the interface is created under docs/
@@ -45,4 +47,25 @@ a version release or commit (as shown above).
4547
4648
- [awesome-rseng](https://github.com/rseng/awesome-rseng/blob/master/.github/workflows/generate-first-issues.yml) to generate first issues from the awesome-rseng repository, with repos listed in [.github/repos.txt](https://github.com/rseng/awesome-rseng/blob/master/.github/repos.txt)
4749
50+
## Questions
51+
52+
## How do I customize the interface?
53+
54+
The interface will always be generated in the docs subfolder, so
55+
if you haven't created it there yet, the action will generate
56+
it the first time around. It's up to you to add all or a subset of
57+
files in docs/* or docs/_issues after the content is generated.
58+
For example, you could add both docs and _issues
59+
in a next step that will commit to an existing or new branch:
60+
61+
```
62+
git add docs/*
63+
git add docs/_issues/*
64+
```
65+
66+
This means that after the original docs is added and merged,
67+
you should be able to customize or otherwise update the template
68+
to your liking. The folder won't be edited if it already exists
69+
beyond the _issues folder.
70+
4871
Do you have an example? Please contribute by opening an issue or a pull request!

img/good-first-issues.png

85.8 KB
Loading

0 commit comments

Comments
 (0)