Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 2.87 KB

Contributing to domainverifier-dotnet

Few open-source projects are going to be successful without contributions. domainverifier-dotnet is no exception and we are deeply grateful for all contributions no matter their size. However, to improve that collaboration this document presents a few steps to smoothen the process.

Finding Existing Issues

Before filing a new issue, please search our issues to check if it already exists.

If you do find an existing issue, please include your own feedback in the discussion. Instead of posting "me too", upvote the issue with 👍, as this better helps us prioritize popular issues and avoids spamming people subscribing to the issue.

Good bug reports make it easier for maintainers to verify and root cause the underlying problem. The better a bug report, the faster the problem will be resolved.

Writing a Good Bug Report

Good bug reports make it easier for maintainers to verify and root cause the underlying problem. The better a bug report, the faster the problem will be resolved.

Contributing Changes

Before you get started, please read the following guidelines.

Prerequisites

  • Git for version control.
  • .NET SDKs for building and testing (.NET 6, 7 & 8)
  • Docker for running the DomainVerifier.Tests project
  • An Integrated Development Environment (IDE) or editor such as:

Fork and Clone

  1. Fork the domainverifier-dotnet repository on GitHub.
  2. Clone your forked repository locally:
git clone https://github.com/yourusername/domainverifier-dotnet.git
  1. Create a new branch for your contribution:
git checkout -b feature/new-feature

Code Changes

  1. Code Style:
    • Follow the coding conventions used in the project.
    • Use consistent formatting and adhere to the style guidelines.
  2. Testing:
    • Write tests for new features or changes.
    • Ensure that existing tests pass before submitting a pull request.
  3. Documentation:
    • Update documentation to reflect any changes made.
    • Ensure that README files are accurate and up-to-date.

Creating a Pull Request

  1. Rebase Your Branch:

    • Before creating a pull request, rebase your branch on the latest upstream changes.

  2. Create Pull Request:

    • Push your changes to your fork and create a pull request on the GitHub repository.

  3. Describe Your Changes:

    Provide a clear and concise description of your changes in the pull request.

  4. Link to Issue:

    • If your changes address a specific issue, reference it in the pull request.

  5. Review and Discussion:

    • Be responsive to comments and feedback during the review process.

Thank You!