Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

40 lines (32 loc) · 2.14 KB

Contributing

Contributions are always welcome as we handle this as an open source project! Here are guidelines how to contribute.

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Contact us to discuss your development so that we are aware of it

Setup

These steps cloud be done once for the project

  • Sign into your GitHub account, or create a free GitHub account if you don't have one.

  • Read license of the project

  • Fork our project repository

    image

    It creates a copy of our project repository in your GitHub account.

    image

    Now, you can update your repository from upstream.

  • Clone repository to desktop

Development

  • Make your branch with specified naming - yourGitHubName_FeatureName - e.g. jarabroz_CacheImprovement
  • Make your development
  • Do not change anything in automatically generated source code files in our libraries instead create new file and put extension here
  • Follow coding standards recommended by Microsoft - see here
  • Make documentation for your development. We prefer to use DocStrings directly in the code, so that documentation could be generated
  • Create Unit Tests for testing your development
  • Create / modify an example where you use newly developed so that it shows usage of the feature
  • Check your spelling and grammar.
  • Update your forked repository from upstream
  • Solve possible conflicts
  • Create Pull Request - see template
  • Your code will be reviewed and all issues needs to be resolved
  • Once Pull request is approved code is merged
  • Branch could be deleted
  • We will add you to the list of the contributors where we mention where you contributed

Please note we have a code of conduct , please follow it in all your interactions with the project.