Adding an athens philosophy document #246
Conversation
arschles
requested review from
bketelsen,
marpio,
michalpristas,
a user and
marwan-at-work
Codecov Report
@@ Coverage Diff @@
## master #246 +/- ##
=======================================
Coverage 41.58% 41.58%
=======================================
Files 79 79
Lines 2032 2032
=======================================
Hits 845 845
Misses 1107 1107
Partials 80 80Continue to review full report at Codecov.
|
README.md
Outdated
| @@ -43,8 +43,11 @@ This project is early and there's plenty of interesting and challenging work to | |||
| If you find a bug or want to fix a bug, we :heart: PRs and issues! If you see an issue | |||
| in the [queue](https://github.com/gomods/athens/issues) that you'd like to work on, please just post a comment saying that you want to work on it. Something like "I want to work on this" is fine. | |||
|
|
|||
| If you decide to contribute (we hope you do :smile:), the process is familiar and easy if you've used Github before. | |||
| There are no long documents to read or complex setup. | |||
| If you decide to contribute (we hope you do :smile:), the process is familiar and easy if you've used Github before. There are no long documents to read or complex setup. | |||
There was a problem hiding this comment.
can you attach brians video for first PR: https://www.youtube.com/watch?v=bgSDcTyysRc
PHILOSOPHY.md
Outdated
|
|
||
| # Guiding Principles | ||
|
|
||
| This is the TL;DR of the whole document! The Athens project has guiding principles: |
There was a problem hiding this comment.
maybe a small change here like s/project has guiding principles/project has {some, a few} guiding principles/
README.md
Outdated
| There are no long documents to read or complex setup. | ||
| If you decide to contribute (we hope you do :smile:), the process is familiar and easy if you've used Github before. There are no long documents to read or complex setup. | ||
|
|
||
| Before you do start contributing or otherwise getting involved, we want to let you know that we follow a general [philosophy](./PHILOSOPHY.md) in how we work together, and we'd really appreciate you to get familiar with it before you start. |
There was a problem hiding this comment.
maybe s/appreciate you to get familiar/appreciate you getting familiar/ or similar
thanks @robjloranger!
|
@robjloranger just pushed the grammar fixes. @michalpristas I'm watching the Go OSS contribution video now 😄 |
|
@michalpristas added the OSS contribution video. I ❤️ it |
I'm attempting here to document generally how we like to work and set some standards so that newcomers know what to expect when they join our community.