Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

69 lines (43 loc) · 3.67 KB
Raw

Contributing to FlexInject

Hello! 🎉 First off, thank you for considering contributing to FlexInject. It's people like you that make FlexInject such a great tool. This document provides guidelines for contributing to FlexInject. These are just guidelines, not rules, so use your best judgment and feel free to propose changes to this document in a pull request.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the FlexInject Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to vitkuz573@gmail.com.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

Before Submitting A Bug Report

  • Perform a cursory search to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A Good Bug Report?

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.

Suggesting Enhancements

Enhancements are tracked as GitHub issues. After you've determined which repository your enhancement is related to, create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the enhancement.
  • Provide a step-by-step description of the suggested enhancement in as much detail as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.

Pull Requests

  • Do not commit changes to files that are irrelevant to your feature or bugfix.
  • Write a good commit message.
  • Pull Requests should be created against the develop branch.
  • Do not create a pull request unless you have tested your changes.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or fewer.
  • Reference issues and pull requests liberally after the first line.

C# Styleguide

Thank You

Your contributions to the community are invaluable, and we look forward to seeing what you will bring to the project. Thank you for being part of FlexInject and making it better!