Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme updates #1

Merged
merged 6 commits into from
Jun 25, 2021
Merged

Readme updates #1

merged 6 commits into from
Jun 25, 2021

Conversation

jenirain
Copy link
Contributor

Issue #, if available:
N/A - this is in preparation for pushing this to open source and publishing to NPM.

Description of changes:
Added some more precise links to the README.md for the Getting Help section
Added link to apache license
Reworded some bits of getting started
In CONTRIBUTING.md - added section for testing code. this still needs details.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jenirain
Copy link
Contributor Author

jenirain commented Jun 21, 2021

Just read in PublishingToNPM wiki page this:

Your .npmignore should actually _exclude_ your original sources (obviously, your gitignore should not do this).

So, I will add an .npmignore file. (If this is wrong, someone on the team will help me understand how to do this properly.

I did not exclude our source file because I don't think we compile to a lib directory. (please advise)

README.md Outdated Show resolved Hide resolved
@jeandek
Copy link
Contributor

jeandek commented Jun 25, 2021

We don't need a .npmignore file, because the package.json explicitly specifies which files to include in the package (via the files key).

Also, your template files look different from what I can see in the docs. Not sure if it's purposeful. EDIT: Never mind, I found another page of docs that use the same syntax as you. Confusing, to say the least...

Other than that, looks good.

@jenirain
Copy link
Contributor Author

Removed .npmignore.

Do you want me to recreate the templates in yaml? I'm more than happy to if you prefer that.

@jeandek
Copy link
Contributor

jeandek commented Jun 25, 2021

Do you want me to recreate the templates in yaml? I'm more than happy to if you prefer that.

I don't think that's necessary. They all seem valid to me.

@jeandek jeandek merged commit 43e93ac into awslabs:main Jun 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants