|
1 | 1 | # Contributing |
2 | 2 |
|
3 | | -We'd love to accept your patches and contributions to this project. |
| 3 | +We welcome patches and contributions to this project. |
4 | 4 |
|
5 | | -## Importing an AEP from google.aip.dev |
| 5 | +## Editing AEP Rules |
6 | 6 |
|
7 | | -Currently, the project is focused on adopting AIPs from |
8 | | -https://google.aip.dev/. You can contribute! |
| 7 | +If you spot a minor issue that seems to be a mistake, such as a typo, please make an PR with a fix. |
9 | 8 |
|
10 | | -You can |
11 | | -[watch the video walkthrough](https://drive.google.com/file/d/1hCBxfTJPINVUpTLnzccJy4pFXZhQQMd3/view?usp=sharing), |
12 | | -or follow the step by step guide: |
| 9 | +For any substantive change or new rule proposal, it is best to search the [discussions](https://github.com/aep-dev/aeps/discussions) |
| 10 | +for similar topics before opening a new one. Lighter weight discussions also happen in #aep channel |
| 11 | +in the CNCF Slack is another place or in our weekly Friday calls for quick validation of the concept. |
13 | 12 |
|
14 | | -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). |
15 | | - - Consider |
16 | | - [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). |
17 | | -1. Navigate to the |
18 | | - [GitHub Repository](https://github.com/aip-dev/google.aip.dev), and find the |
19 | | - AIP in the |
20 | | - [general directory](https://github.com/aip-dev/google.aip.dev/tree/master/aip/general). |
21 | | - Copy the raw content. |
22 | | -1. Create a directory for the aep, and update the aep.yaml file to "approved". |
23 | | - [Full example PR](https://github.com/aep-dev/aep.dev/pull/77/files). |
24 | | -1. Modify the content from the aip markdown and paste over the aep.md content. |
25 | | - - Remove any Google-isms (e.g. replace Google domains with example.com). |
26 | | - - Extend any proto-specific guidance to include both OpenAPI and proto. |
27 | | - representations. |
28 | | -1. Create a GitHub PR. A reviewer should be with you in 24 hours. |
29 | | - - If a reviewer does not review within that time, please ping @rofrankel or |
30 | | - @toumorokoshi. |
31 | | - - Leave comments on any parts of the text that you would like to discuss. |
32 | | -1. Come say hi in our various communication channels documented in the |
33 | | - [README](README.md#learn-and-connect). |
34 | | - |
35 | | -Some tips: |
36 | | - |
37 | | -- Less is more. If there's a hard disagreement about particular guidance, |
38 | | - consider filing a follow-up issue to get the agreed upon guidance merged. |
39 | | -- Perfect is the enemy of good. Feel free to submit PRs that are mostly there, |
40 | | - and leave questions so reviewers can help address any questions or concerns. |
| 13 | +Once there is a clear point of view articulated and some amount of support gathered, the next step |
| 14 | +would be to open a PR to reference the discussion and describe the work to be done. Any subsequent |
| 15 | +pull request should then reference the issue and will enter the queue for review. |
41 | 16 |
|
42 | 17 | ## Development Environment |
43 | 18 |
|
44 | 19 | If you are contributing AEP content (rather than code) and want to be able to |
45 | | -view it in your browser, the easiest way to do so is to run the site-generator |
46 | | -script. |
47 | | - |
48 | | -We use [GitHub Pages][1] to make this documentation available, and a specific |
49 | | -[site generator][2] to build the site. |
50 | | - |
51 | | -Run `./scripts/serve.sh` to: |
52 | | - |
53 | | -- clone the site-generator repository. |
54 | | -- run the appropriate npm commands. |
55 | | -- begin the dev server at port 4321. |
56 | | - |
57 | | -### Hot reloading |
58 | | - |
59 | | -The development server currently does not support hot reloading. |
| 20 | +view it in your browser, the easiest way to do so is to use our [site-generator project](https://github.com/aep-dev/site-generator). |
60 | 21 |
|
61 | 22 | ### Updating examples |
62 | 23 |
|
|
0 commit comments