Skip to content

Commit 4ce4351

Browse files
committed
address norm's comments
1 parent e2f8819 commit 4ce4351

File tree

3 files changed

+44
-93
lines changed

3 files changed

+44
-93
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,45 @@ To send us a pull request, please:
3939
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4040
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4141

42+
## Adding a `change file` to your contribution branch
43+
44+
Each contribution branch should include a `change file` that contains a changelog message for each project that has been updated, as well as the type of increment to perform for those changes when versioning the project.
45+
46+
A `change file` looks like the following example:
47+
```json
48+
{
49+
"Projects": [
50+
{
51+
"Name": "Amazon.Extensions.S3.Encryption",
52+
"Type": "Patch",
53+
"ChangelogMessages": [
54+
"Fixed an issue causing a failure somewhere"
55+
]
56+
}
57+
]
58+
}
59+
```
60+
The `change file` lists all the modified projects, the changelog message for each project as well as the increment type.
61+
62+
These files are located in the repo at .autover/changes/
63+
64+
You can use the `AutoVer` tool to create the change file. You can install it using the following command:
65+
```
66+
dotnet tool install -g AutoVer
67+
```
68+
69+
You can create the `change file` using the following command:
70+
```
71+
autover change -m "Fixed an issue causing a failure somewhere"
72+
```
73+
Note: Make sure to run the command from the root of the repository.
74+
75+
The possible increment types are:
76+
* Patch
77+
* Minor
78+
* Major
79+
80+
Note: You do not need to create a new `change file` for every changelog message or project within your branch. You can create one `change file` that contains all the modified projects and the changelog messages.
4281

4382
## Finding contributions to work on
4483
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.

src/Amazon.Extensions.S3.Encryption.csproj

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
<SignAssembly>true</SignAssembly>
1919
<AssemblyOriginatorKeyFile>..\public.snk</AssemblyOriginatorKeyFile>
2020
<PackageReadmeFile>README.md</PackageReadmeFile>
21+
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
2122
</PropertyGroup>
2223

2324
<PropertyGroup Condition="'$(TargetFramework)' == 'net472'">
@@ -35,6 +36,10 @@
3536
<PackageReference Include="AWSSDK.S3" Version="4.0.0-preview.2" />
3637
<PackageReference Include="AWSSDK.KeyManagementService" Version="4.0.0-preview.2" />
3738
<PackageReference Include="BouncyCastle.Cryptography" Version="2.4.0" />
39+
</ItemGroup>
40+
41+
<!-- TODO: The dependency on Microsoft.Bcl.AsyncInterfaces should be removed once the issue causing it to be needed in the .NET SDK is fixed -->
42+
<ItemGroup Condition="'$(TargetFramework)' == 'net472' Or '$(TargetFramework)' == 'netstandard2.0'">
3843
<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="8.0.0" />
3944
</ItemGroup>
4045

src/Util/ConcurrentDictionary.cs

Lines changed: 0 additions & 93 deletions
This file was deleted.

0 commit comments

Comments
 (0)