mirror of
https://github.com/godotengine/godot-team-reports.git
synced 2025-12-31 13:48:17 +03:00
Update readme with more contribution details, and fix a couple of issues
This commit is contained in:
6
.github/workflows/ci.yml
vendored
6
.github/workflows/ci.yml
vendored
@@ -4,7 +4,7 @@ on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
schedule:
|
||||
# Every day at midnight (UTC).
|
||||
# Every day every two hours starting at midnight (UTC).
|
||||
- cron: '0 0,2,4,6,8,10,12,14,16,18,20,22 * * *'
|
||||
|
||||
jobs:
|
||||
@@ -15,10 +15,10 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Install Node.js 12.x
|
||||
- name: Install Node.js 14.x
|
||||
uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: 12.x
|
||||
node-version: 14.x
|
||||
cache: 'npm'
|
||||
|
||||
- name: Install dependencies
|
||||
|
||||
33
README.md
33
README.md
@@ -1,12 +1,33 @@
|
||||
# Godot Team Reports
|
||||
|
||||
This project is provided for Godot engine contributors to monitor stale
|
||||
and old PRs and help clean up the review backlog.
|
||||
This project is provided for Godot engine contributors to monitor stale and old PRs
|
||||
and help clean up the review backlog. PRs are grouped by the teams assigned to review
|
||||
them, so that maintainers have a good overview of their area of the engine.
|
||||
|
||||
## Contributing
|
||||
|
||||
This project is written in JavaScript and built using Node.JS. Generated content is completely
|
||||
static and can be served from any web server without Node.JS. On the front end it uses
|
||||
Web Components to achieve reactivity and interactivity without reliance on heavy UI libraries.
|
||||
This project is written in JavaScript and built using Node.JS. HTML and CSS are used
|
||||
for presentation. The end result of the build process is completely static and can
|
||||
be server from any webserver, no Node.JS required.
|
||||
|
||||
Further details on contributing will be added later.
|
||||
Front-end is designed in a reactive manner using industry standard Web Components
|
||||
(powered by `lit-element`). This provides native browser support, and results in a
|
||||
small overhead from the build process.
|
||||
|
||||
To build the project locally you need to have Node.JS installed (12.x and newer
|
||||
should work just fine).
|
||||
|
||||
1. Clone or download the project.
|
||||
2. From the project root run `npm install` or `yarn` to install dependencies.
|
||||
3. Run `npm run build` or `yarn run build` to build the pages.
|
||||
4. Run `npm run compose` or `yarn run compose` to fetch the data from GitHub.
|
||||
5. Serve the `out/` folder with your method of choice (e.g. using Python 3:
|
||||
`python -m http.server 8080 -d ./out`).
|
||||
|
||||
`rollup` is used for browser packing of scripts and copying of static assets. The
|
||||
data fetching script is plain JavaScript with `node-fetch` used to polyfill
|
||||
`fetch()`-like API.
|
||||
|
||||
## License
|
||||
|
||||
This project is provided under the [MIT License](LICENSE.md).
|
||||
|
||||
@@ -49,7 +49,7 @@ const ReportsFormatter = {
|
||||
},
|
||||
|
||||
formatDays(days) {
|
||||
return days + " " + (days !== 0 ? "days" : "day")
|
||||
return days + " " + (days !== 1 ? "days" : "day");
|
||||
},
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user