Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

82 lines (58 loc) · 3.7 KB

Contributing

Thank you for your interest in contributing to Unity High Precision Framework!

Here are our guidelines for contributing:

Code of Conduct

Please help us keep Unity High Precision Framework open and inclusive. Read and follow our Code of Conduct.

Ways to Contribute

There are many ways in which you can contribute to High Precision Framework.

Issues and Bugs

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Feature Requests

You can request a new feature by submitting an issue to our GitHub Repository.

If you would like to implement a new feature then consider what kind of change it is:

  • Major Changes that you wish to contribute to the project should be discussed first with other developers. Submit your ideas as an issue.

  • Small Changes can be directly submitted to the GitHub Repository as a Pull Request. See the section about Pull Request Submission Guidelines.

Documentation

We accept changes and improvements to our documentation. Just submit a Pull Request with your proposed changes as described in the Pull Request Submission Guidelines.

All contributions are subject to the Unity Contribution Agreement(UCA)

By making a pull request, you are confirming agreement to the terms and conditions of the UCA, including that your Contributions are your original creation and that you have complete right and authority to make your Contributions.

Pull Request Submission Guidelines

We use the Gitflow Workflow for the development of the High Precision Framework. This means development happens on the develop branch and Pull Requests should be submited to it.

Branch Name Prefix

  • bug/ Fixing a bug
  • feature/ New feature implementation
  • perf/ Performance improvement
  • refactor/ A code change that neither fixes a bug nor adds a feature
  • doc/ Added documentation
  • test/ Added Unit Tests
  • build/ Changes that affect the build system or external dependencies
  • ci/ Changes to our CI configuration files and scripts
  • style/ Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

Requirements

  • The branch name has the respective prefix.
  • Changelog entry added under Unreleased section.
    • Explains the change in Modified, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • If UI or rendering results applies, include screenshots.
    • FogBugz ticket attached, example ([case %number%](https://issuetracker.unity3d.com/issues/...)).
    • FogBugz is marked as Resolved with next release version correctly set.
  • Tests added/changed, if applicable.
    • Functional tests.
    • Performance tests.
    • Integration tests.
  • All Tests passed.
  • Documentation was added for new/changed.
    • XmlDoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
  • Coding Standards are respected.
  • Rebase the branch if possible.