CONTRIBUTING

[z-ZYS-s]

CONTRIBUTING

Contributing Guide for Repositories in this Organization.

Hi! Thank you in advance for using Vusion.

Issue Reporting Guidelines

• The issue list is reserved exclusively for bug reports, feature and design related requests. Issue that does not conform to the requirements might be closed immediately. If you have usage questions, please contact us through Slack or Gitter.
• Please confirm that similar issues are not put forward before a new issue is reported.
• Please point out the version of Vusion and Vue as well as information of operating system and browser. JSFiddle is recommended to display problem more visually.

Branch Management Guidelines

• Use git pull --rebase instead of git pull.
• develop branch is the development branch for next medium or large version while master branch is used for a production environment version.
• When fixing a complex bug, a bugfix branch named bugfix/BUG_NAME should be checked out from master branch to solve the bug.
• When adding a new feature, a feature branch named feature/FEATURE_NAME should be checked out from master branch to develop the feature.

Commit Message Format

• Capitalize first letter ("Fix a bug" not "some bug")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Use the present tense ("Add feature" not "Added feature")
• Do not end with dot(.)
• Limit the first line to 72 characters or less
• Use # to reference issues and pull requests as possible
• Use gitmoji to start the commit message with an applicable emoji:
  • ✨ :sparkles: when introducing new features
  • 🐛 :bug: when fixing a bug
  • ⚡️ :zap: when improving performance
  • 🎨 :art: when improving structure / format of the code
  • 🔨 :hammer: when refactoring code
  • 🚚 :truck: when moving or renaming files
  • 🔥 :fire: when removing code or files
  • 📝 :memo: when writing docs
  • ✏️ :pencil2 when fixing typos
  • 💄 :lipstick: when updating the UI and style files
  • ✅ :white_check_mark: when adding tests
  • 🚧 :construction: when working in progress
  • ⬆️ :arrow_up: when upgrading dependencies
  • 🔖 :bookmark: when releasing / version tags
  • ... more
• One commit completes one job is recommended. If there are multiple tasks, please use the ;+ separated.
• Use the <> to wrap a component name when it occurs in commit message.

Recommended Example

• :sparkles: Complete <u-tabs>; Publish [email protected]; Close #4321
• :bug: Fix error in <u-list-view>; Fix #1234

Pull Request Guidelines

• Follow 'Branch Management Guidelines' and 'Commit Message Format' mentioned above.
• When it comes to a bugfix PR, make sure that the commit message is complete and understandable.
• Two steps are required to merge a PR: one organization member review the code and approve, and another organization member review the code again before the final merge.

Release Strategy

• Run vusion publish v*.*.*.
• Add release message in reference to publish template to the corresponding tag version in the page of the release page of the repository.
• Ensure version synchronization between master branch and the latest release version after a new release, and develop branch can be synchronized as appropriate.

On the premise of npm account has login, vusion publish will be executed in the following procedure

• Revise the version in package.json file and commit.
• Run npm publish.
• Run git push to push revise to origin branch.
• Run git tag v*.*.* where v*.*.* is the version in package.json file.
• Run git push origin v*.*.* to push the tag to origin branch.

Code Standards

JavaScript Style

Please configure ESLint in the editor. See eslint-config-vusion for more details.

CSS Naming

Use REA Standard to name css selector.

[cainiaolaoyang]

ss