Penguin Delivery is an international organization which needs localization in order to fit every visitor ;). Penguin Delivery currently needs support from the localizers of the following languages:
The localization support will be divided into two priority categories: Primary and Secondary.
The languages in this group should always have full and high-quality localizations in order to provide model for other localizations.
zh-cn: Chinese Simplified
zh-tw: Chinese Traditional
en-us: English (United States)
ja-jp: Japanese
This group don't have any strict requirements, but localizations are welcome.
en-uk: English (United Kingdom)
ko-kr: Korean (Korea)
Clone the project: git clone https://github.com/GalvinGao/penguin-stats-frontend.git
Install yarnpkg : Official Guide
Install project dependencies:yarn
Fire up the development server: yarn serve
Get your favorite IDE and start developing!
This project uses commitizen to organize commit messages. In order to utilize such tool, please:
Install commitizen: yarn global add commitizen
To start working on a feature/issue, use git checkout -b {branchName} to create a branch and switch to such branch; also, the {branchName} should in the following format:
When you are working on a feature, use feat-{featureName}
When you are working on a fix, use fix-{issueNumber}-{issueSlug} where in {issueSlug} please describe the issue in one or two words
When you finished a feature/fixed a issue, use git add {file} to add your file into the change list and git cz to commit your changes
Use git push --set-upstream origin {branchName} to push the branch to remote side (GitHub, in this case)
Go to https://github.com/penguin-statistics/frontend-v2/pull/new/ to create a Pull Request and wait for reviewers to review your change
First of all, thanks for your interest in contributing Penguin Statistics!
Please notice that the v4 Frontend is now in maintenance mode and a new version frontend is being planned and bootstrapped with React. New feature implementation is currently paused on the current v3 frontend.
MVVC Framework: Vue.js; project created using vue-cli@3.
UI Framework: Vuetify.js, a framework that implements Material Design.
CI: Vercel (previously ZEIT), GitHub Actions & Kubernetes.io
CD: Kubernetes.io in progress
Project Repo: https://github.com/penguin-statistics/frontend-v2
You can contribute to the frontend of the website in many ways: