docs: improve developer documentation for folks new to the codebase

* Correct example invocation of aws cli

* Add warning to Helm Intellisense recommendation

* Link code conventions in PR guidelines

* Tighten debugd README

* cmake is not used for building debugd anymore, remove references to it

* make the debug-cluster workflow the authoritative source for cdbg usage - don't replicate the same instructions in different places

* Document that Bazel eats a lot of RAM
This commit is contained in:
Markus Rudy 2023-11-17 19:16:52 +01:00 committed by GitHub
parent e51513985a
commit 69c64d6c69
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 11 additions and 36 deletions

View file

@ -8,7 +8,7 @@ For pull requests, we employ the following workflow:
1. Fork the repository to your own GitHub account
2. Create a branch locally with a descriptive name
3. Commit changes to the branch
4. Write your code according to our development guidelines
4. Write your code according to our [development guidelines](../conventions.md)
5. Push changes to your fork
6. Clean up your commit history
7. Open a PR in our repository and summarize the changes in the description