(docs) Add Contributing Guidelines #2760
Conversation
joshgoebel
changed the title
|
See #2760 (comment) Also, I'm not comfortable writing the philosophy section having barely contributed anything 😄. Do you mind taking care of that? Lastly, I can get to work on the "reporting an issue" section. What kinds of issues are useful, and are there any specific rules? |
Yeah, I was planning to. Give me the weekend. I'll try and skeleton in some thoughts on the other stuff as well. |
|
@joshgoebel friendly ping (regarding "build & test" and "philosophy" sections) |
CONTRIBUTING.md
Outdated
| - has a working familiarity with Regex? (you won't get too far without this) | ||
| - perhaps has some rough familiarity with the idea of parsing text in general? | ||
| - is willing to read our grammar documentation and look at other grammars? | ||
|
|
There was a problem hiding this comment.
We need to find a way to expand this to make it clear there are multiple potential things to work on... someone could submit a new theme without knowing any JS or regex, etc... When I wrote this i was primarily thinking of fixing grammar bugs, etc (our most common type of issue).
|
@allejo @egor-rogov Any high level thoughts here (or i guess tiny concerns also welcome)? I'm ok if this is a bit bare-bones initially and we flesh it out over time, but it definitely needs to be "useful" before we merge it. |
This is looking good to me! Just a few minor grammar concerns here and there but I'll hold off of that until this PR is ready to be reviewed. My only thought right now would be to have the "Setup and Run" section be third instead of last. I personally like trying to figure out if I can build/run a project before I get involved with tackling issues/PRs. But other than that, I think the order and sections included here are good. |
Sounds reasonable. |
|
@joshgoebel Update: I know I've let this pull request snowball 🤦. There are a couple of suggestion threads which have grown stale, and I'm not sure whether to wait for a response or to disregard them. The "reporting an issue" section needs some TLC. Beyond that, can you outline for me what's keeping it from being merged? |
|
Let me have another look-see. |
|
Can you work on the small things I just flagged and remove all the "draft" mentions... then I'll got over it myself with one last edit pass and we can merge! |
Outlined the document, and started 3 sections.
Sections 1 & 4 are 2nd drafts Sections 2,3 and 5 are ready for writing
- new section for feature requests - a fair bit of rewriting
Co-authored-by: Josh Goebel <me@joshgoebel.com>
joshgoebel
changed the title
Resolves #2753
Changes
Added contributing.md, for the benefit of new contributors.
Checklist
CHANGES.md- see aboveAUTHORS.txt, under Contributors - see above