Wrote with ❤️ by Jimmy Lan (@lanyanxiang).
Mobile application for Poly Events project.
Jimmy Lan @lanyanxiang
Sheldon Su @Sheldonsu28
Chenhao Gong @shoko-inori
Evence Wang @evencewang
Jaedon Cheung @JaedonC
Sixuan Wu @wsxwsx543
Bruce Qian @bruceqianzz
Note: Please add your name here once your first pull request is merged!
This repository follows standard Poly Team contribution guidelines.
You should always use SSH, not HTTPS, to clone Poly Team repositories. If you are new to GitHub or have not set up an SSH key on GitHub before, please refer to Adding a new SSH key to your GitHub account.
Usually, we do not clone repositories directly from the Poly Team organization. You would begin contributing to our projects by forking the repository.
However, due to the recent security concerns and incompatible workflows, please do not submit pull requests from a forked repository for now.
Please clone this repository directly.
Regular branches should be grouped into the following categories:
- feature
- bugfix
- hotfix
- release
Please use the following convention to name your branch:
<branch_category>/<ticket_id>-<short_description>
For example, feature/723-update-readme.
Sometimes, ticket IDs may begin with a prefix.
In this case, you should include the prefix as well.
For instance, if the prefix is PE1, then you may name your branch feature/PE1-723-update-readme.
Please note that special branches may exist and may exempt from this rule.
For example, there are two main branches master and develop.
You may also see branches using names containing only a version ID (for publishing a package).
You will see two types of commit-message conventions at Poly Team Solutions. We call them standard commits and conventional commits. For more information about conventional commits, please read Conventional Commits 1.0.0.
This repository uses standard commits.
This repository uses standard commits. Please write your commit messages using the following convention:
- Begin with a capital letter, followed by lower-case letters;
- Begin with a verb, in present tense;
- We recommend short commit subject lines (< 75 characters).
✅ Do:
- Fix login form display error
❌ Don't:
-
Fixed login form display error
-
Fixing login form display error
-
fixed login form display error
-
login form display has an error
-
Update login form to eliminate a hard-to-find and deeply-buried error which no one but me could find
To merge your code into the main repository, you need to create a pull request. A pull request allows your code to be reviewed by another member before it is merged into one of the main branches.
The subject line of your pull request needs to follow the following convention:
If a ticket system is not used:
[<branch_category>] <short_description>
If a ticket system is used:
[<branch_category>/<ticket_id>] <short_description>
where the initial letter of <branch_category> and <short_description> are capitalized.
Notice that we generally wrap <branch_category>/<ticket_id> inside of a pair of square brackets.
For example,
[Feature/PE1-723] Update README.md
Once you create a pull request on GitHub, you should perform the following:
- Assign one or more reviewers that you think might be relevant to this pull request;
- Assign yourself and/or other members as assignee for the pull request;
- Add relevant labels to your pull request (e.g., "enhancement");
- Wait and verify that the status checks pass, if applicable;
- Look into the "Files" tab, making sure that no unnecessary file changes were checked out to Git.
A few resources to get you started if this is your first Flutter project:
For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.