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.

Sign up for GitHub

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

Jump to bottom

chore(docs): update CONTRIBUTING #4754

Merged
merged 4 commits into from
Nov 27, 2019
Merged

chore(docs): update CONTRIBUTING #4754

merged 4 commits into from
Nov 27, 2019

Conversation

hacker65536
Copy link
Contributor

@hacker65536 hacker65536 commented Oct 30, 2019 •
edited
Loading

Remove description about install.sh

related #4588

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@mergify
Copy link
Contributor

mergify bot commented Oct 30, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

nmussy
nmussy reviewed Oct 30, 2019
View reviewed changes
CONTRIBUTING.md Outdated
@@ -364,7 +363,7 @@ $ docker run -v $(pwd):/app -w /app aws-cdk <CDK ARGS>
In many cases, you don't really need to build the entire project. Say you want to work on the `@aws-cdk/aws-ec2` module:

```console
$ ./install.sh
$ ./build.sh
Copy link
Contributor

@nmussy nmussy Oct 30, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not really appropriate to replace install.sh with build.sh here. The goal of this section is to only build a specific package and its dependencies.

Looks like a simple yarn install would do the trick

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nmussy Thank you for your advice. I'll replace it.

nmussy
nmussy reviewed Oct 30, 2019
View reviewed changes
CONTRIBUTING.md Outdated
@@ -468,7 +467,7 @@ Cycle: @aws-cdk/aws-sns => @aws-cdk/aws-lambda => @aws-cdk/aws-codecommit => @aw
To update all dependencies (without bumping major versions):

1. Obtain a fresh clone from "master".
2. Run `./install.sh`
2. Run `./build.sh`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment here, yarn install might be sufficient?

@nmussy
Copy link
Contributor

nmussy commented Oct 30, 2019

Tagging @RomainMuller to correct me if I'm wrong

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@nmussy
Copy link
Contributor

nmussy commented Oct 30, 2019

There is also a mention of the removed package-lock.json in CONTRIBUTING:

Make sure package-lock.json files are included in your commit.

Seen as there's only a single yarn.lock at the root of the monorepo, I'm not sure how to change that one

@SomayaB SomayaB assigned rix0rrr and RomainMuller and unassigned rix0rrr Oct 30, 2019
@RomainMuller RomainMuller merged commit cf787c7 into aws:master Nov 27, 2019
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@hacker65536 hacker65536 deleted the fixcontributingmd branch November 28, 2019 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nmussy nmussy nmussy left review comments

@RomainMuller RomainMuller RomainMuller approved these changes

Assignees

@RomainMuller RomainMuller

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@hacker65536 @aws-cdk-automation @nmussy @RomainMuller @rix0rrr