Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

38 lines (28 loc) · 1.58 KB

Instructions for Logging Issues

1. Search for Duplicates

Search the existing issues before logging a new one.

2. Do you have a question?

The issue tracker is for issues, in other words, bugs and suggestions. If you have a question, please ask on Gitter.

3. Did you find a bug?

When logging a bug, please be sure to include the following:

  • What version of CodeTiger.Core you're using
  • If at all possible, an isolated way to reproduce the behavior
  • The behavior you expect to see, and the actual behavior

4. Do you have a suggestion?

Suggestions are also accepted in the issue tracker.

In general, the following are useful when reviewing suggestions:

  • A description of the problem you're trying to solve
  • An overview of the suggested solution
  • Examples of how the suggestion would work in various places

Instructions for Contributing Code

To be accepted, a pull request must:

  • Include a description of what your change intends to do
  • Have clear commit messages
    • e.g. "Fixed a deadlock when AsyncLazy is used from non-async code", "Added unit tests for Guard.ArgumentIsNotNull", etc.
  • Build without any warnings
  • Roughly follow existing coding style
  • Have all unit test passing
    • At least one test should fail in the absence of your non-test code changes. If your PR does not match this criteria, please specify why
    • Tests should include reasonable permutations of the target fix/change
  • Not introduce any new dependencies