Skip to content

Latest commit

 

History

History
118 lines (88 loc) · 5.96 KB

CONTRIBUTING.md

File metadata and controls

118 lines (88 loc) · 5.96 KB
Raw

Contributions Welcome

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.

If you're looking to report a bug or would like to propose a new feature, please follow the bug and potential feature workflow.

If you'd like to submit your own changes to the Litexa codebase, please follow the contribution workflow. If you want to ask for high-level but still commit-based feedback for a contribution, please follow the request for comments steps instead.

Reporting Bugs and Potential Features

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

When filing an issue, please check existing open and recently closed issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can.

For bugs, these details are very useful:

  • test case or series of steps to reproduce the bug
  • commit hash or NPM package version used
  • anything unusual about your environment or deployment

For feature requests, these details are very useful:

  • exact use case(s) for which the feature would be useful
  • exit criteria (when would this feature be considered complete)

Contribution Workflow

Litexa applies the “fork-and-pull” development model. Please follow these steps if you want to merge your changes to the master version:

  1. If you haven't already, create a fork of the Litexa repository.
  2. In your cloned fork, create a branch (with a meaningful name) for your contribution.
  3. Commit your contribution, which should comply with our contribution quality standards
  4. Create a pull request against the develop branch of the Litexa repository.
  5. Add two reviewers to your pull request (a maintainer will do that for you if you're new). Work with your reviewers to address any comments and obtain a minimum of 2 approvals, at least one of which must be provided by a maintainer. To update your pull request amend existing commits whenever applicable and then push the new changes to your pull request branch.
  6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
  7. Once the pull request is approved, one of the maintainers will merge it.

Request for Comments

If you just want to receive feedback for a contribution proposal, open an “RFC” (“Request for Comments”) pull request:

Follow steps 1-3 from the above contribution workflow.

  1. Create a pull request against the develop branch of the . Prefix your pull request name with [RFC].
  2. Discuss your proposal with the community on the pull request page (or on any other channel). Add the conclusion(s) of this discussion to the pull request page.

Contribution Quality Standards

Most quality and style standards are enforced automatically during integration testing. Your contribution needs to meet the following standards:

  • Separate each logical change into its own commit.
  • The full pull request must pass all integration tests. See https://github.com/alexa-games/litexa for more information on style and tests.
  • Unit test coverage must increase the overall project code coverage.
  • Include integration tests for any new functionality in your pull request.
  • Document all your public functions.
  • Commits in your forked repository may be brief or absent.
  • Document your pull requests. Include the reasoning behind each change, and the testing done. Following commit message best practices is recommended. Your pull request will be squashed into a single commit if it is approved.
  • Acknowledge Litexa is provisionally licensed as "Restricted Program Materials" under the Program Materials License Agreement(LICENSE) and certify that no part of your contribution contravenes this license by signing off on all your commits with git -s. Ensure that every file in your pull request has a header referring to the repository license file.

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.

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.

Licensing

See the LICENSE file for our project's licensing and the NOTICE for anything that differs or related notices. 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.