Skip to content

Commit

Permalink
Rename DEVELOPING.md to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Kai Tillman <[email protected]>
  • Loading branch information
kai-tillman authored and Alice-Lilith committed Sep 3, 2024
1 parent 30c8adc commit 010ac84
Show file tree
Hide file tree
Showing 7 changed files with 935 additions and 6 deletions.
2 changes: 1 addition & 1 deletion DevDocumentation/DEVELOPING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -811,7 +811,7 @@ curl localhost:8877/ambassador/v0/diag/?loglevel=debug
```

Note: This affects diagd and Envoy, but NOT the AES `amb-sidecar`.
See the AES `DEVELOPING.md` for how to do that.
See the AES `CONTRIBUTING.md` for how to do that.

### Can I build from a docker container instead of on my local computer?

Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ A few sentences describing what testing you've done, e.g., manual tests, automat
- We should lean on the bulk of code being covered by unit tests, but...
- ... an end-to-end test should cover the integration points

- [ ] **I updated `DEVELOPING.md` with any any special dev tricks I had to use to work on this code efficiently.**
- [ ] **I updated `CONTRIBUTING.md` with any special dev tricks I had to use to work on this code efficiently.**

- [ ] **The changes in this PR have been reviewed for security concerns and adherence to security best practices.**
2 changes: 1 addition & 1 deletion Community/MEETING_SCHEDULE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The Emissary-ingress Contributors Meeting is held on the first Wednesday of every month at 3:30pm Eastern. The focus of this meeting is discussion of technical issues related to development of Emissary-ingress.

New contributors are always welcome! Check out our [contributor's guide](../DevDocumentation/DEVELOPING.md) to learn how you can help make Emissary-ingress better.
New contributors are always welcome! Check out our [contributor's guide](../DevDocumentation/CONTRIBUTING.md) to learn how you can help make Emissary-ingress better.

**Zoom Meeting Link**: [https://ambassadorlabs.zoom.us/j/86139262248?pwd=bzZlcU96WjAxN2E1RFZFZXJXZ1FwQT09](https://ambassadorlabs.zoom.us/j/86139262248?pwd=bzZlcU96WjAxN2E1RFZFZXJXZ1FwQT09)
- Meeting ID: 861 3926 2248
Expand Down
2 changes: 1 addition & 1 deletion DevDocumentation/BUILDING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Building Ambassador
===================

The content in this document has been moved to [DEVELOPING.md].
The content in this document has been moved to [CONTRIBUTING.md].
929 changes: 929 additions & 0 deletions DevDocumentation/CONTRIBUTING.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion DevDocumentation/SECURITY_RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ These steps should be completed within the 1-7 days of Disclosure.
[CVSS](https://www.first.org/cvss/specification-document) using the [CVSS
Calculator](https://www.first.org/cvss/calculator/3.0). The Fix Lead makes the final call on the
calculated CVSS; it is better to move quickly than to spend time making the CVSS perfect.
- The Fix Team will work per the usual [Emissary Development Process](DEVELOPING.md), including
- The Fix Team will work per the usual [Emissary Development Process](CONTRIBUTING.md), including
fix branches, PRs, reviews, etc.
- The Fix Team will notify the Fix Lead that work on the fix branch is complete once the fix is
present in the relevant release branch(es) in the private security repo.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The best way to join the community is to join the [CNCF Slack](https://community

Check out the [`DevDocumentation/`](DevDocumentation/) directory for
information on the technicals of Emissary, most notably the
[`DEVELOPING.md`](DevDocumentation/DEVELOPING.md) contributor's guide.
[`CONTRIBUTING.md`](DevDocumentation/CONTRIBUTING.md) contributor's guide.

If you're interested in contributing, here are some ways:
* Write a blog post for [our blog](https://blog.getambassador.io)
Expand Down

0 comments on commit 010ac84

Please sign in to comment.