Improve contribution guide #7075
Conversation
* commit 'ccb045b68c5b4d983a90fa125513fc476e4e2387': fix: upgrade @graphql-tools/links from 6.2.4 to 6.2.5 (parse-community#7007) fix: upgrade pg-promise from 10.7.0 to 10.7.1 (parse-community#7009) fix: upgrade jwks-rsa from 1.10.1 to 1.11.0 (parse-community#7008) fix: upgrade graphql from 15.3.0 to 15.4.0 (parse-community#7011) update stale bot (parse-community#6998) fix(beforeSave/afterSave): Return value instead of Parse.Op for nested fields (parse-community#7005) fix(beforeSave): Skip Sanitizing Database results (parse-community#7003) Fix includeAll for querying a Pointer and Pointer array (parse-community#7002) Init (parse-community#6999)
Codecov Report
@@ Coverage Diff @@
## master #7075 +/- ##
==========================================
+ Coverage 85.41% 93.85% +8.44%
==========================================
Files 169 169
Lines 12425 12425
==========================================
+ Hits 10613 11662 +1049
+ Misses 1812 763 -1049
Continue to review full report at Codecov.
|
|
@mtrezza would you see any value in including some basic fork / commit / submit a PR instructions using a visual tool such as GitHub desktop? I know for me understanding git was a challenge at the start. |
|
That's a good idea, I actually think screenshots and code examples are key here. It may be the flood of text that discourages some new developers from getting into contributing. It surely must be for people who tend to absorb information visually. If we have some extra time, I would like to add some tutorial videos as well. Would you want to write the 1-2-3 instructions for some parts? Thinking of a storyboard, we could have roughly these scenes:
I'm thinking the guide should be focused on bug fixing. We've had many instances where obvious small bugs were identified that would have been easy to fix, but the bug reporter did not know how to do that. The result was that the bugs stayed unfixed for longer than necessary. Additional guides regarding:
Additional processes for:
|
100% agree. The beauty of this package is that it is accessible to developers of all skill levels, which often means that some terminology or processes might be hard to understand for some new developers. I would be more than happy to write instructions if you'd require me to. I was thinking I could tackle #7058 (as I think it will be a pretty easy fix) and walk through the entire process from fork, spec, PR, merge, etc, and maybe that could be as a blog post on blog.parseplatform.org? |
Do you mean as a screen recording or why do you mention the specific issue #7058?
Good idea, the new contribution guide could make for an interesting blog post once it's done. |
|
This originally larger PR has been broken up into smaller tasks by moving the discussion into issue #7100. |
* commit '7f47b0427ea56214d9b0199f0fcfa4af38794e02': Add page localization (parse-community#7128) Improve contribution guide (parse-community#7075) fix: upgrade pg-promise from 10.9.0 to 10.9.1 (parse-community#7170) Add tests against multiple MongoDB versions (parse-community#7161) fix: upgrade mime from 2.4.7 to 2.5.0 (parse-community#7166) fix: upgrade pg-promise from 10.8.7 to 10.9.0 (parse-community#7168) fix: upgrade apollo-server-express from 2.19.1 to 2.19.2 (parse-community#7165) Upgrade @node-rs/bcrypt to latest version (parse-community#7159) Run Prettier after Definitions (parse-community#7164)
* add Parse Error guide * add Parse Server config guide * removed old instructions for adding config parameters
|
🎉 This change has been released in version 5.0.0-beta.1 |
|
🎉 This change has been released in version 5.0.0 |
New Pull Request Checklist
Issue Description
The contribution guide is missing documented processes for:
This sometimes resulted in incomplete implementations in the past.
Related issue: #7100
Approach
Added processes.
TODOs before merging
(none)
Edit: This originally larger PR has been broken up into smaller tasks by moving the discussion into issue #7100.