- Small formatting fix - removed trailing period from
the "I can't finish the contribution I started" heading
to match the style of other headings in the same
section.
Co-authored-by: sterner-13-macumba <259387217+sterner-13-macumba@users.noreply.github.com>
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [x] Documentation update
## Motivation and Context
- Added an index to the doc for easily accessing important sections
- Added two new main sections to help first time contributors with tips
on how to get started with issues, how to ask for help, and who to ask
for help.
- Made all headings sentence case for consistency
Closes https://github.com/apple/container/issues/880, as it was
preferred to not add a `CODEOWNERS` file, but instead add notes to where
contributors can find a list of maintainers to ping.
## Testing
- [ ] Tested locally
- [ ] Added/updated tests
- [x] Added/updated docs
These truthfully should be up to users to maintain, as trying to add
everyones editor of choice config directories here isn't ideal.
This additionally adds a section in contributing on the new stance.
We require signed commits as of yesterday, and it'd be nice to have this
in writing somewhere to avoid contributors getting blindsided when
github has a scary x on the merge button.
Remove Latin abbreviations from the documentation in accordance with the
[Apple Style Guide](https://help.apple.com/applestyleguide/). This
change does not impact any abbreviations used in code comments since
those are not covered by the style guide.
## Summary
Corrects a grammatical error in CONTRIBUTING.md line 36.
## Change
**Line 36**: `speed of which` → `speed at which`
The preposition "of" is incorrect when connecting the noun "speed" with
the relative pronoun "which". Standard English requires "at" (e.g., "the
speed at which", "the rate at which").
**Before:**
```
This will greatly help the priority setting and speed of which maintainers can get to your issue.
```
**After:**
```
This will greatly help the priority setting and speed at which maintainers can get to your issue.
```
Some updates to the documentation:
* Replace code-of-conduct with organization one.
* Cleanup `CONTRIBUTING.md`, `README.md` and `SECURITY.md` markdown.
* Remove `.txt` extension from `LICENSE` for consistency across repos.
