Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (30 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 1.67 KB
Raw

Contributing to LUOYE Codex Meter

Thank you for improving the project. LUOYE Codex Meter follows an upstream contribution model: public changes return to the Official Repository through pull requests, and official releases remain in one place.

Chinese guide: CONTRIBUTING.zh-CN.md

Workflow

  1. Fork LUOYEcode/LUOYE-Codex-Meter on GitHub.
  2. Create a focused branch for one change.
  3. Build with ./build.ps1 and test the affected behavior on Windows.
  4. Open a pull request against main in the Official Repository.
  5. Respond to review and keep the pull request focused.

The fork and branch may remain public for contribution purposes. Do not create a GitHub Release, package, installer, executable download, or independent project from modified code. See LICENSE.

Pull request expectations

  • Explain what changed and why.
  • Include screenshots for visible UI changes.
  • Describe the Windows version and display scaling used for UI testing.
  • Keep account tokens, proxy subscriptions, personal paths, logs, and other private data out of commits and screenshots.
  • Avoid unrelated formatting or refactoring.

Contribution terms

By submitting a pull request, you confirm that you have the right to submit the contribution and agree to section 6 of the LUOYE Community Source License. You retain copyright in your work while granting LUOYE the rights needed to review, merge, maintain, license, and publish it as part of the official project.

Opening a pull request does not guarantee that it will be merged. Maintainers may request changes, edit a contribution with the contributor's agreement, or decline work that does not fit the project.