You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!-- Provide summary of changes -->
<!-- Issue number, if available. E.g. "Fixes#31", "Addresses #42, 77" -->
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Bump build go build runtime to latest release series, go1.14.x
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Thanks for your interest in contributing to the AWS Copilot CLI! 💖
4
4
5
-
This document describes how to set up a development environment and submit your contributions.
5
+
This document describes how to set up a development environment and submit your contributions.
6
6
Please read it over and let us know if it's not up-to-date (or, even better, submit a PR with your corrections 😉).
7
7
8
8
-[Development setup](#development-setup)
@@ -20,7 +20,7 @@ Please read it over and let us know if it's not up-to-date (or, even better, sub
20
20
21
21
### Environment
22
22
23
-
- Make sure you are using Go 1.13 (`go version`).
23
+
- Make sure you are using Go 1.14 (`go version`).
24
24
- Fork the repository.
25
25
- Clone your forked repository locally.
26
26
- We use Go Modules to manage dependencies, so you can develop outside of your $GOPATH.
@@ -37,17 +37,17 @@ From the repository root run:
37
37
38
38
There are three different types of testing done on the AWS Copilot CLI.
39
39
40
-
**Unit tests** makes up the majority of the testing and new code should include unit tests.
41
-
Ideally, these unit tests will be in the same package as the file they're testing and have full coverage (or as much is practical within a unit test).
40
+
**Unit tests** makes up the majority of the testing and new code should include unit tests.
41
+
Ideally, these unit tests will be in the same package as the file they're testing and have full coverage (or as much is practical within a unit test).
42
42
Unit tests shouldn't make any network calls.
43
43
44
-
**Integration tests** are rarer and test the CLI's integration with remote services, such as the file system, CloudFormation, or SSM.
44
+
**Integration tests** are rarer and test the CLI's integration with remote services, such as the file system, CloudFormation, or SSM.
45
45
Our integration tests ensure that we can call these remote services and get the results we expect.
46
46
47
-
**End to End tests** run the CLI in a container and test the actual commands - including spinning and tearing down remote resources (like ECS clusters and VPCs).
48
-
These tests are the most comprehensive and run on both Windows and Linux build fleets.
49
-
Feel free to run these tests - but they require two AWS accounts to run in, so be mindful that resources will be created and destroyed.
50
-
You'll need three [named profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html): `default`, `e2etestenv` and `e2eprodenv`.
47
+
**End to End tests** run the CLI in a container and test the actual commands - including spinning and tearing down remote resources (like ECS clusters and VPCs).
48
+
These tests are the most comprehensive and run on both Windows and Linux build fleets.
49
+
Feel free to run these tests - but they require two AWS accounts to run in, so be mindful that resources will be created and destroyed.
50
+
You'll need three [named profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html): `default`, `e2etestenv` and `e2eprodenv`.
51
51
Each e2e profile needs to be configured for a different AWS account and a different region than the other e2e profiles.
52
52
53
53
Below are the different commands which can be run in the root of the project directory.
@@ -65,17 +65,17 @@ Often times, it's helpful to generate mocks to make unit-testing easier and more
65
65
66
66
## Adding new dependencies
67
67
68
-
In general, we discourage adding new dependencies to the AWS Copilot CLI. If there's a module you think the CLI could benefit from, first open a PR with your proposal.
68
+
In general, we discourage adding new dependencies to the AWS Copilot CLI. If there's a module you think the CLI could benefit from, first open a PR with your proposal.
69
69
We'll evaluate the dependency and the use case and decide on the next steps. To evaluate if we need to add the dependency please take a look at [https://research.swtch.com/deps](https://research.swtch.com/deps).
70
70
71
71
## Where should I start?
72
72
73
-
We're so excited you want to contribute to the CLI! We welcome all PRs and will try to get to them as soon as possible.
73
+
We're so excited you want to contribute to the CLI! We welcome all PRs and will try to get to them as soon as possible.
74
74
The best place to start, though, is with filing an issue first. Filing an issue gives us some time to chat about the code you're keen on writing, and make sure that it's not already being worked on, or has already been discussed.
75
75
76
76
You can also check out our [issues queue](https://github.com/aws/copilot-cli/issues) to see all the known issues - this is a really great place to start.
77
77
78
-
If you want to get your feet wet, check out issues tagged with [good first issue](https://github.com/aws/copilot-cli/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
78
+
If you want to get your feet wet, check out issues tagged with [good first issue](https://github.com/aws/copilot-cli/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
79
79
These issues are great for folks who are looking to get started, but not sure where to start 😁.
0 commit comments