Skip to content

Latest commit

 

History

History
123 lines (81 loc) · 3.98 KB

CONTRIBUTING.md

File metadata and controls

123 lines (81 loc) · 3.98 KB
Raw

Contributing to dotnet-sops

Welcome to the dotnet-sops repository on GitHub! We're excited that you're interested in contributing to our project. Your contributions, whether they're in the form of code, documentation, bug reports, or feature requests, play a crucial role in making this project better for everyone.

Please take a moment to review this Contributing Guide before you get started. It outlines the process for contributing to dotnet-sops and provides important information on how to submit your contributions.

Table of Contents

Getting Started

Prerequisites

Make sure you have the following prerequisites installed before you start contributing:

Development

Restore tools

Install required dotnet tools by running the following command:

dotnet tool restore

Build

Code can be compiled by running the following command:

dotnet build

Warnings are treated as errors in Release configuration build.

Test

Test can be executed by running the following command:

dotnet test

Lint

Lint of code can be checked by the following command:

dotnet format --verify-no-changes
dotnet csharpier . --check

All rules are defined by .editorconfig file

Package

Tool can be packed by the following command:

dotnet pack

Releases

Creating release

Releases are created by maintainers following this process:

  1. Checkout latest main branch 
    git checkout main
git pull
  2. Create a signed tag on the main branch with a semantic version number, e.g., "v0.1.0" or "v0.1.0-alpha.1". 
    git tag -s -m <version> <version>
  3. Push the tag to GitHub. This action initiates a new build and generates a draft release on GitHub. 
    git push origin <version>
  4. Verify the release and publish it. This initiates a workflow that uploads the release to NuGet.org.

Contributing

Submitting Issues

If you find a bug, have a question, or want to request a new feature, please open an issue on GitHub. Provide a clear and detailed description of the issue, and use the appropriate issue template if available.

Creating Pull Requests

We welcome pull requests (PRs) from contributors. To submit a PR:

  1. Make sure your forked repository is up to date with the latest changes from the main repository.
  2. Create a new branch for your feature/bug fix.
  3. Make your changes and commit them with a clear and concise message.
  4. Push your changes to your forked repository.
  5. Open a pull request against the main branch of the main repository. Provide a detailed description of your changes and reference any related issues.
  6. When all checks are green and all feedback have been addressed, we will merge the pull request with the "Squash and merge" option.

Coding Guidelines

We follow the same coding guidelines used by dotnet/aspnetcore. Some of the coding guidelines are enforced by the .editorconfig file.

Documentation

Good documentation is essential for the success of any project. Help us improve dotnet-sops's documentation by creating clear, concise, and easy-to-understand documentation.

License

By contributing to dotnet-sops, you agree that your contributions will be licensed under the MIT License. Make sure you understand and agree to the terms before submitting your contributions.