This repository has been archived by the owner on Oct 2, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Added open-source-related documentation. (#46)
* Added contribution guidelines. * Added GitHub issue templates. * Added license information. * Updated the documentation URL.
- Loading branch information
Showing
348 changed files
with
3,430 additions
and
3,134 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: New Issue | ||
about: This is not a feature or a bug | ||
title: 'Issue: ' | ||
labels: '' | ||
--- | ||
|
||
# Issue Details | ||
|
||
## Current Litexa Version | ||
|
||
## Current Behavior | ||
|
||
## Desired Behavior | ||
|
||
## Additional Information | ||
|
||
```javascript | ||
// code samples | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
name: Create a bug report | ||
about: Report something that's broken | ||
title: 'Bug: ' | ||
labels: 'bug' | ||
--- | ||
|
||
# Bug Report | ||
|
||
## Litexa Version | ||
|
||
## Current Behavior | ||
|
||
## Expected Behavior | ||
|
||
## Steps to Reproduce | ||
|
||
## Additional Information | ||
|
||
<!-- Any additional useful information goes here --> | ||
## Operating System | ||
|
||
## Node Version | ||
|
||
```javascript | ||
// code samples | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Create a feature request | ||
about: Suggest an idea for improvement | ||
title: 'Feature: ' | ||
labels: 'feature' | ||
--- | ||
|
||
# Feature Request | ||
|
||
## Current Litexa Version | ||
|
||
## Current Behavior | ||
|
||
## Desired Behavior | ||
|
||
## Additional Information | ||
|
||
```javascript | ||
// code samples | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Title | ||
|
||
<!--- Provide a general summary of your changes in the Title above. --> | ||
|
||
## Description | ||
|
||
<!--- Describe your changes in detail. --> | ||
|
||
## Motivation and Context | ||
|
||
<!--- Why is this change required? What problem does it solve? --> | ||
<!--- If it addresses an open [issue][issues], please link here. --> | ||
|
||
## Testing | ||
|
||
<!--- Please describe in detail how you tested your changes. --> | ||
<!--- Include details of your testing environment, and the tests you ran to --> | ||
<!--- see how your change affects other areas of the code, etc. --> | ||
|
||
## Types of changes | ||
|
||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to change) | ||
|
||
## Checklist | ||
|
||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
|
||
- [ ] My code follows the code style of this project | ||
- [ ] My change requires a change to the documentation | ||
- [ ] I have updated the documentation accordingly | ||
- [ ] I have read the **README** document | ||
- [ ] I have added tests to cover my changes | ||
- [ ] All new and existing tests passed | ||
|
||
## License | ||
|
||
<!--- Litexa is released under the [Apache License, Version 2.0][license], so any code you submit will be released under that license. --> | ||
<!--- For substantial contributions, we may ask you to sign a [Contributor License Agreement (CLA)][cla]. --> | ||
<!--- Put an `x` in the below box if you confirm that this request can be released under the Apache 2 license: --> | ||
- [ ] I confirm that this pull request can be released under the Apache 2 license | ||
|
||
[issues]: https://github.com/alexa-games/litexa/issues | ||
[license]: https://www.apache.org/licenses/LICENSE-2.0 | ||
[cla]: http://en.wikipedia.org/wiki/Contributor_License_Agreement |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Always validate the PR title, and ignore the commits | ||
titleOnly: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Code of Conduct | ||
|
||
This project has adopted the | ||
[Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). | ||
For more information see the | ||
[Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact | ||
[opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) | ||
with any additional questions or comments. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
# 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](#reporting-bugs-and-potential-features). | ||
|
||
If you'd like to submit your own changes to the Litexa codebase, please follow the | ||
[contribution workflow](#contribution-workflow). If you want to ask for high-level but still | ||
commit-based feedback for a contribution, please follow the | ||
[request for comments](#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](https://github.com/alexa-games/litexa/issues) and | ||
[recently closed](https://github.com/alexa-games/litexa/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20) | ||
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](https://help.github.com/en/articles/fork-a-repo) of the | ||
[Litexa](https://github.com/alexa-games/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](#contribution-quality-standards) | ||
4. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) | ||
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](MAINTAINERS.md). 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](#contribution-workflow). | ||
|
||
4. [Create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) | ||
against the `develop` branch of the . Prefix your pull request name with `[RFC]`. | ||
5. 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](https://github.com/erlang/otp/wiki/writing-good-commit-messages) | ||
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](https://github.com/alexa-games/litexa/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'](https://github.com/alexa-games/litexa/labels/help%20wanted) issues is a great place | ||
to start! | ||
|
||
## Code of Conduct | ||
|
||
This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
||
## 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](http://aws.amazon.com/security/vulnerability-reporting/). | ||
Please do **not** create a public github issue. | ||
|
||
## Licensing | ||
|
||
See the [LICENSE](https://github.com/alexa-games/litexa/blob/master/LICENSE) file for our project's | ||
licensing and the [NOTICE](https://github.com/alexa-games/litexa/blob/master/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)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) | ||
for larger changes. |
Oops, something went wrong.