Skip to content

Latest commit

 

History

History
142 lines (104 loc) · 6.35 KB

CONTRIBUTING.md

File metadata and controls

142 lines (104 loc) · 6.35 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps
  • The version of our code being used
  • Any modifications you've made relevant to the bug
  • Anything unusual about your environment or deployment

Contributing via Pull Requests

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

  1. You are working against the latest source on the master branch.
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
  3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

To send us a pull request, please:

  1. Fork the repository.
  2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
  3. Ensure local tests pass.
  4. Commit to your fork using clear commit messages.
  5. Send us a pull request, answering any default questions in the pull request interface.
  6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional document on forking a repository and creating a pull request.

Adding a change file to your contribution branch

Each contribution branch should include a change file that contains a changelog message for each project that has been updated, as well as the type of increment to perform for those changes when versioning the project.

A change file looks like the following example:

{
  "Projects": [
    {
      "Name": "Amazon.Lambda.Tools",
      "Type": "Patch",
      "ChangelogMessages": [
        "Fixed an issue causing a failure somewhere"
      ]
    }
  ]
}

The change file lists all the modified projects, the changelog message for each project as well as the increment type.

These files are located in the repo at .autover/changes/

You can use the AutoVer tool to create the change file. You can install it using the following command:

dotnet tool install -g AutoVer

You can create the change file using the following command:

autover change --project-name "Amazon.Lambda.Tools" -m "Fixed an issue causing a failure somewhere

Note: Make sure to run the command from the root of the repository.

You can update the command to specify which project you are updating. The available projects are:

  • Amazon.ECS.Tools
  • Amazon.ElasticBeanstalk.Tools
  • Amazon.Lambda.Tools

The possible increment types are:

  • Patch
  • Minor
  • Major

Note: You do not need to create a new change file for every changelog message or project within your branch. You can create one change file that contains all the modified projects and the changelog messages.

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Security issue notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.

Local Tool Development

The plugin can be tested locally using launchSettings.json. For example, to debug the the deploy-serverless command:

{
  "profiles": {
    "Amazon.Lambda.Tools": {
      "commandName": "Project",
      "commandLineArgs": "deploy-serverless",
      "workingDirectory": "D:\\Path\\To\\Your\\Lambda\\Project"
    }
  }
}

Alternatively you can install your development build as a global tool by adding the bin directory as an additional package source. It is helpful to bump the version number to ensure that you are installing your local debug version rather than the remote nuget version, but consider reverting the version number before submitting the PR.

# All commands below are run from the `Amazon.Lambda.Tools` project directory e.g. `D:\repos\aws-extensions-for-dotnet-cli\src\Amazon.Lambda.Tools`.

# Build the project
PS > dotnet build

# Create nuget package
PS > dotnet pack

# Uninstall any existing versions
PS > dotnet tool uninstall -g Amazon.Lambda.Tools

# Install your debug build by adding your bin directory to the list of nuget sources
PS > dotnet tool install -g Amazon.Lambda.Tools --version 4.0.1 --add-source ./bin/Debug 

# Test that you get the expected version number when you run the tool
PS > dotnet lambda
Amazon Lambda Tools for .NET Core applications (4.0.1)

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a Contributor License Agreement (CLA) for larger changes.