2.6 KiB
2.6 KiB
Rules
Table of Contents
Basics
This is a rough guideline. (Not forced)
Feel free to make PR.
Issue
Search:
- Search the project’s issues to make sure it's not a known issue.
Versions:
- Make sure you’re on the latest version.
- Try older versions.
- Try switching up dependency versions.
Version
Milestone, The versioning scheme we use is SemVer. (Maintainer decides, do not pull request.)
We will release the feature as soon as it is complete, but the cycle should be 2-4 weeks. Rapid releases.
It comes from #109.
Branch
Stable: Only bugfix, Documentation.
master
: Common bugfix, documentation.photon-style
: Bugfix, documentation specified inphoton-style
.proton-sryle
: Bugfix, documentation specified inproton-style
.
Development: New Features.
dev
: Common new features.photon-style-dev
: New features specified inphoton-style
.proton-style-dev
: New features specified inproton-style
.
Edit
Modify only source file
Do not modify files that are built directly or automatically generated.
Coding style
- Indent: 2 spaces for indentation rather than tabs.
- Columns: Fit
80
~100
columns as much as possible. (Auto formatting is using 120 to avoid the worst case)
Commits
Commit
- Meaningfully:: It doesn't make meaningless commits.
- One per task: It's difficult to distinguish when various tasks are mixed.
- Often: Codes may corrupt during large changes.
Commit Message
For intuitive recognition, I put a prefix.
Add:
Add feature or enhanced.Bump:
Update dependency packages.Fix:
Bug fix or change default values.Clean:
Refactoring.Doc:
Update docs.
Pull request
- Branch: Check the Branch section and PR to the correct branch.
- Issue: We recommend that you open the issue first to discuss the changes with the owner of this repository.
- Build: Please check if it was built before PR.