Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

63 lines (41 loc) · 3.15 KB

Contribution Guidelines

Contributions are welcomed! Here's a few things to know:

Steps to Contributing

Here are the basic steps to get started with your first contribution. Please reach out with any questions.

  1. Use open issues to discuss the proposed changes. Create an issue describing changes if necessary to collect feedback. Also, please use provided labels to tag issues so everyone can easily sort issues of interest.
  2. Fork the repo in order if you want to make and test local changes.
  3. Create a new branch from master for the issue. We suggest prefixing the branch with type of contribution (bugfix/feature), your username and then a descriptive title: (e.g. bugfix/user1/object-comparision or feature/user2/variable-initialization-check)
  4. Make code changes.
  5. Ensure unit tests pass and code coverage minimum is satisfied.
  6. Create a pull request against master branch.

Code of conduct

Apart from the official Code of Conduct it is highly recommended to adopt the following behaviors, to ensure a great working environment:

Do not point fingers

Let’s be constructive.

Click here to see some examples

"This method is missing xmldoc" instead of "YOU forgot to put xmldoc".

Provide code feedback based on evidence

When making code reviews, try to support your ideas based on evidence (papers, library documentation, stackoverflow, etc) rather than your personal preferences.

Click here to see some examples

"When reviewing this code, I saw that the constructor of MyClass is fulfilled with many untrivial operations. However, Microsoft's official guideline on constructor design says that we should do minimal work in the constructor. We should follow the standard in the industry."

Ask questions do not give answers

Try to be empathic.

Click here to see some examples
  • Would it make more sense if ...?
  • Have you considered this ... ?

HydraScript Contributor License Agreement

Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once in this repo.