Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guidance phrased as personal opinion #142

Closed
andyw8 opened this issue Jun 6, 2015 · 4 comments
Closed

Guidance phrased as personal opinion #142

andyw8 opened this issue Jun 6, 2015 · 4 comments

Comments

@andyw8
Copy link

andyw8 commented Jun 6, 2015

BetterSpecs seems to be intended as a community effort, but many the explanations use the word 'I' since the were originally written by @andreareginato.

I believe this discourages others from contributing updates advice. I would suggest taking an approach similar to the Ruby Style Guide, where the guidance is intended to capture the community's collective viewpoint, so is written from a non-personal point of view.

@onebree
Copy link
Contributor

onebree commented Jun 8, 2015

@andyw8 I included your suggestion in a recent todo list. I agree that any guide should be written in a commanding way (second person?). As you noted, Andrea originally wrote many of the guidelines. I do not feel, however, that his use of first-person is the reason why people do not contribute. I think people do not contribute much because PRs and issues have been stales for quite some time. (I have tried to resolve that.)

You are free to contribute as much as you'd like, as well as anyone else. If you want to rephrase the tips to be in second person, then submit a PR. Also, if possible, include changes to the translations.

@andyw8
Copy link
Author

andyw8 commented Jun 8, 2015

Yes, I agree, it's probably not the main factor.

Regarding translations, there's probably another question there about to keep the different versions 'in sync'.

@onebree
Copy link
Contributor

onebree commented Jun 8, 2015

We are working together on figuring how to keep translations "in sync" with the English pages. If you have any ideas, do let us know.

@andyw8 andyw8 closed this as completed Jun 8, 2015
@andyw8 andyw8 reopened this Jun 8, 2015
@akz92
Copy link
Member

akz92 commented Mar 20, 2020

I noticed this a few days ago too and I agree that it doesn't look great. Please feel free to change those phrasings, closing for now.

@akz92 akz92 closed this as completed Mar 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants