Skip to content

Commit

Permalink
fix api approval doc images (#3236)
Browse files Browse the repository at this point in the history
  • Loading branch information
marcpiechura authored and Aaronontheweb committed Jan 2, 2018
1 parent bc6bce1 commit 0045438
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/community/public-api-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,24 @@ The approval file is located at:
### Approving a New Change
After modifying some code in Akka.NET that results in a public API change - this can be any change, such as adding an overload to a public method or adding a new public class, you will immediately see an API change when you attempt to run the `Akka.API.Tests` unit tests:

![Failed API approval test](/images/api-diff-fail.png)
![Failed API approval test](../images/api-diff-fail.png)

The tests will fail, because the `.approved.txt` file doesn't match the new `.received.txt`, but you will be prompted by [ApprovalTests](https://github.com/approvals/ApprovalTests.Net) to view the diff between the two files in your favorite diff viewer:

![API difference as seen in a diff viewer like TortoiseMerge or WinMerge](/images/api-diff-viewer.png)
![API difference as seen in a diff viewer like TortoiseMerge or WinMerge](../images/api-diff-viewer.png)

After you've merged the changes generated from your code into the `approved.txt` file, the tests will pass:

![Passed API approval test](/images/api-diff-approve.png)
![Passed API approval test](../images/api-diff-approve.png)

And then once you've merged in those changes, added them to a Git commit, and sent them in a pull request then other Akka.NET contributors will review your pull request and view the differences between the current `approved.txt` file and the one included in your PR:

![approved.txt differences as reported by Git](/images/diff-results.png)
![approved.txt differences as reported by Git](../images/diff-results.png)

## Unacceptable API Changes
The following types of API changes will generally not be approved:

1. Any modification to a commonly used public interface;
2. Changing any public method signature or removing any public members;
3. Renaming public classes or members; and
4. Changing an access modifier from public to private / internal / protected on any member that is or is meant to be used.
4. Changing an access modifier from public to private / internal / protected on any member that is or is meant to be used.

0 comments on commit 0045438

Please sign in to comment.