Grammar and syntax edits for the style guide

[Kenneth-Stanfield]

I've been carefully reviewing the Zalando RESTful API Guidelines document for a project I'm working on. As a native English speaker, I've noticed a number of sentences and phrases in the Zalando document with incorrect grammar or syntax.

I'd like to correct these small errors by making a PR consisting of extremely targeted edits. My intention is NOT to re-write sentences. I only want to correct grammar and syntax mistakes in the simplest way possible.

Before I undertake this work with a feature branch and a PR, I'd like one of the owners of this repo to weigh in with an opinion about whether this work would be a worthwhile expenditure of my time.

[tfrauenstein]

Hi Kenneth, great, we highly appreciate a PR for improving the language. (The authors are no native English speakers.)

[tkrop]

Hi @Kenneth-Stanfield can only confirm what @tfrauenstein has added. We will gladly support you to get any improvement to our strange grammar merged.

[Kenneth-Stanfield]

Thank you for the quick responses, @tkrop & @tfrauenstein

I will create a feature branch for making simple edits and corrections.

We'll need to discuss some sentences and phrases before I can suggest improvements. There are two ways to manage this:

• via in-line comments in the PR
• via comments in this Issue discussion

I look forward to collaborating with you on this project. Overall, I think the authors of this widely-used document from Zalando did great work. I hope I can add some value to the mix.

[tfrauenstein]

@Kenneth-Stanfield great. It is editorial work where we prefer in-line comments in the PR. Looking forward to your PR, thx.

[Kenneth-Stanfield]

I created a local branch (with no changes) and tried to make an initial push to the remote. But I'm getting a 403 error inside SourceTree, my visual front-end to Git.

remote: Permission to zalando/restful-api-guidelines.git denied to Kenneth-Stanfield. fatal: unable to access 'https://github.com/zalando/restful-api-guidelines.git/': The requested URL returned error: 403

The branch name I want is kstanfield-grammar

Do I need permission to push to a remote feature branch?

[ePaul]

Hi, for making a pull request to a repository where you don't have write access, the usual approach is to fork the repository, and then push a branch to your own fork. (You might need to add the remote first: use git remote add for this.) Github will then automatically suggest to create a PR to the original repository.

(As this is a corporately owned repository, we generally won't give direct write access to non-employees.)

[Kenneth-Stanfield]

Thanks for that information, ePaul. I'll fork the repo as suggested.

I have a follow-up question. I'd like to get some initial feedback from the community (for changes to a single file) before moving forward. If I work inside my own fork, making regular checkins, will it be easy for folks on this thread to review my in-progress work?

Thanks

[ePaul]

I have a follow-up question. I'd like to get some initial feedback from the community (for changes to a single file) before moving forward. If I work inside my own fork, making regular checkins, will it be easy for folks on this thread to review my in-progress work?

Just open a (possibly draft) PR from your branch (and link it to this issue). We can either merge the changes to the one file when fine (and you then continue with the others and open a new one), or you can just continue working on the branch (which will show up in the PR) and we merge it at the end, as you prefer.