Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 35 additions & 51 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,45 @@
# Contributing

We'd love to accept your patches and contributions to this project.

## Importing an AEP from google.aip.dev

Currently, the project is focused on adopting AIPs from
https://google.aip.dev/. You can contribute!

You can
[watch the video walkthrough](https://drive.google.com/file/d/1hCBxfTJPINVUpTLnzccJy4pFXZhQQMd3/view?usp=sharing),
or follow the step by step guide:

1. [Select an AIP to adopt into an AEP from the open issues with the label "adoption"](https://github.com/aep-dev/aep.dev/labels/adoption).
- Consider
[ones also with the label "good first issue"](https://github.com/aep-dev/aep.dev/issues?q=is%3Aopen+label%3A%22good+first+issue%22+label%3Aadoption).
1. Navigate to the
[GitHub Repository](https://github.com/aip-dev/google.aip.dev), and find the
AIP in the
[general directory](https://github.com/aip-dev/google.aip.dev/tree/master/aip/general).
Copy the raw content.
1. Create a directory for the aep, and update the aep.yaml file to "approved".
[Full example PR](https://github.com/aep-dev/aep.dev/pull/77/files).
1. Modify the content from the aip markdown and paste over the aep.md content.
- Remove any Google-isms (e.g. replace Google domains with example.com).
- Extend any proto-specific guidance to include both OpenAPI and proto.
representations.
1. Create a GitHub PR. A reviewer should be with you in 24 hours.
- If a reviewer does not review within that time, please ping @rofrankel or
@toumorokoshi.
- Leave comments on any parts of the text that you would like to discuss.
1. Come say hi in our various communication channels documented in the
[README](README.md#learn-and-connect).

Some tips:

- Less is more. If there's a hard disagreement about particular guidance,
consider filing a follow-up issue to get the agreed upon guidance merged.
- Perfect is the enemy of good. Feel free to submit PRs that are mostly there,
and leave questions so reviewers can help address any questions or concerns.
We welcome patches and contributions to this project.

## Development Environment
## Learn and Connect

If you are contributing AEP content (rather than code) and want to be able to
view it in your browser, the easiest way to do so is to run the site-generator
script.
If you'd like to get involved in the AEP community, we'd love to have you! The
following channels of communication are available:

- [The #aep channel in the CNCF Slack](https://cloud-native.slack.com/archives/C04TX46UCTV).
Sign up at https://slack.cncf.io.
- We hold a weekly project meeting on Fridays. See
[the AEP Google Calendar, to view any upcoming meetings](https://calendar.google.com/calendar/u/0/embed?src=7e35dd3df194a32f4fa7c03a3454e24ba3651e6f568248efe1ddf1e34a7bee9e@group.calendar.google.com&ctz=America/Los_Angeles)
for details. Options for other times, such as more EU-friendly meetings, can
also be arranged.

## Editing AEP Rules

We use [GitHub Pages][1] to make this documentation available, and a specific
[site generator][2] to build the site.
If you spot a minor issue that seems to be a mistake, such as a typo, please
make an PR with a fix.

Run `./scripts/serve.sh` to:
For any substantive change or new rule proposal, it is best to search the
[discussions](https://github.com/aep-dev/aeps/discussions) for similar topics
before opening a new one. Lighter weight discussions also happen in #aep
channel in the CNCF Slack is another place or in our weekly Friday calls for
quick validation of the concept.

- clone the site-generator repository.
- run the appropriate npm commands.
- begin the dev server at port 4321.
Once there is a clear point of view articulated and some amount of support
gathered, the next step would be to open a PR to reference the discussion and
describe the work to be done. Any subsequent pull request should then reference
the issue and will enter the queue for review.

### Hot reloading
## Development Environment

If you are contributing AEP content (rather than code) and want to be able to
view it in your browser, the easiest way to do so is to run
`./scripts/serve.sh` to:

The development server currently does not support hot reloading.
- clone the [site-generator project](https://github.com/aep-dev/site-generator)
repository
- run the appropriate npm commands
- begin the dev server at port 4321

### Updating examples

Expand All @@ -73,7 +56,8 @@ Specifically, the following files are copied over:
### Formatting

This repository uses [prettier](https://prettier.io/) and a bespoke script
[scripts/fix.py](scripts/fix.py). Please check the
[scripts/fix.py](https://github.com/aep-dev/aeps/blob/main/scripts/fix.py).
Please check the
[lint.yaml](https://github.com/aep-dev/aeps/blob/main/.github/workflows/lint.yaml)
for the specific file.

Expand Down
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,12 @@ of clients and tooling for protobuf and HTTP REST APIs.

## Overview

See [GOVERNANCE.md](./GOVERNANCE.md).
See [Governance](https://aep.dev/governance/).

## Learn and Connect
## Get Involved

If you'd like to get involved in the AEP community, we'd love to have you! The
following channels of communication are available:

- [The #aep channel in the CNCF Slack](https://cloud-native.slack.com/archives/C04TX46UCTV).
Sign up at https://slack.cncf.io.
- [The AEP Google Calendar, to view any upcoming meetings](https://calendar.google.com/calendar/u/0/embed?src=7e35dd3df194a32f4fa7c03a3454e24ba3651e6f568248efe1ddf1e34a7bee9e@group.calendar.google.com&ctz=America/Los_Angeles)
- A weekly project meeting is held, which anyone interested is welcome to
attend!
There are lots of ways to contribute! See:
[Contributing](https://aep.dev/contributing/)

## License

Expand Down