Skip to content

Latest commit

 

History

History
81 lines (66 loc) · 3.68 KB

CONTRIBUTING.rst

File metadata and controls

81 lines (66 loc) · 3.68 KB

How to Contribute

Contributions are welcome! First time contributor? No worry, it's alright. We've all been there. There are many ways to contribute to open source projects: reporting bugs, helping with the documentation, spreading the word and of course, adding new features and patches.

Getting Started

  1. Make sure you have a GitLab account.
  2. Open a new issue, assuming one does not already exist.
  3. Clearly describe the issue including steps to reproduce when it is a bug.

Making Changes

  • Fork the repository on GitLab.
  • Create a branch from where you want to base your work. This is usually from the master branch.
  • Please avoid working directly on master branch.
  • Make commits of logical units (if needed rebase your feature branch before submitting it).
  • Make sure your commit messages are in the proper format.
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken.
  • Don't forget to add yourself to AUTHORS.

These guidelines also apply when helping with documentation.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a Pull Request.
  • Wait for maintainer feedback.

Don't know where to start?

There are usually several TODO comments scattered around the codebase, maybe check them out and see if you have ideas and can help with them. Also, check the open issues in case there's something that sparks your interest. In any case, other than GitLab help pages, you might want to check this excellent Effective Guide to Pull Requests

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 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 [email protected] 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 issue.

Licensing

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