Skip to content

Commit

Permalink
chore: adding contributors guides
Browse files Browse the repository at this point in the history
To help with onboarding and migration of more AEPs,
adding a contributors guide.
  • Loading branch information
toumorokoshi committed Feb 7, 2024
1 parent 8ff6148 commit ffc009d
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

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 importing AIPs from https://google.aip.dev/. You can contribute! the process is:

1. [Select an aip to adopt from the open adoption issues](https://github.com/aep-dev/aep.dev/labels/adoption).
1. 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).
2. Find the original AIP, which is suffixed with the number in the issue. For example https://google.aip.dev/126.
3. Click on "view source" on the page, click on "raw", and copy the content.
4. Create a directory for the aep, split the content in to an aep.md an aep.yaml. [Example PR](https://github.com/aep-dev/aep.dev/pull/77/files).

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.

## Development Environment

If you are contributing AEP content (rather than code) and want to be able to
Expand Down

0 comments on commit ffc009d

Please sign in to comment.