docs: add pull-request section #233
Conversation
|
✔️ Deploy Preview for api-clients-automation canceled. 🔨 Explore the source changes: c9f2c33 🔍 Inspect the deploy log: https://app.netlify.com/sites/api-clients-automation/deploys/622620096f24d00007186481 |
website/docs/pullRequest.md
Outdated
| @@ -0,0 +1,7 @@ | |||
| --- | |||
| title: Send pull-request | |||
There was a problem hiding this comment.
The title/file name could be more descriptive, since we are in contributing it would be something like
Pushing to GitHub or idk
There was a problem hiding this comment.
Yeah, I agree. Since it's under contributing, we want to describe "actually how to contribute", and... we do not push directly to gh, so we want to explain how to send a pull-request, so that's how I ended up with that title 😅 Any other suggestion?
There was a problem hiding this comment.
Actually, reading again, just Pull-request seems fine 🤔
* docs: add pull-request page * Update pullRequest.md
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-313
Changes included:
In the future, we can add more information to this page about things like _generated, how generated clients are not committed, etc.