search

aws / aws-cryptographic-material-providers-library-java

AWS Cryptographic Material Providers Library for Java
Apache License 2.0
4 stars 6 forks source link

chore: refactor directories so they symlink to dafny repo #199

Open josecorella opened 1 year ago

josecorella commented 1 year ago

Issue #, if available:

Description of changes:

Squash/merge commit message, if applicable:

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

josecorella commented 12 months ago 
1. Can we replace the top README here with a Symlink to the Java MPL's README?

git will do the right symlink behavior and will show the appropriate thing when you clone it down - github will not. On Github it will show a pointer to go to the linked place in the submodule and you will actually have to click and navigate the submodule which is suboptimal.

2. Same ^, but for the CHANGELOG?

same as above

texastony commented 12 months ago

Fudge.

I want our Java repo to look like a Java Repo...

With the Changelog and README specific to the product (MPL-Java).

Let's call this out of scope for this PR, but maybe we should "define" the Java README and CHANGELOG here instead of there.

That way, viewers land on the right page.

(And do the same for all the runtime repos)

josecorella commented 12 months ago

i'm slightly confused....

the changelog and readme here will not change. when we release we will have to update the changelog here so it matches the changes made in mpl-dafny; the changelog is also repo specific. The mpl for .net is also an example of this.

texastony commented 12 months ago

Oh! So this CHANGELOG and README are already the Java specific ones?

I checked the files changed by this PR and did not see them, so I assumed they were from the MPL-Dafny's root.