-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
Improve contribution guide #7100
Comments
@julianvogels could help us to improve this one 🙂 (ref: https://community.parseplatform.org/t/what-you-love-about-parse-and-also-of-the-difficulties-you-have-encountered/1140/5 ) |
@mtrezza on my first contribution, I remember that running Today, systems like I know https://www.npmjs.com/package/concurrently that allow to execute 2 commands at the same time. I found that Jasmine do not have watch mode: jasmine/jasmine-npm#5 So by adding i also found that we can add the babel compiler to our jasmine.json: https://github.com/piecioshka/test-jasmine-babel/blob/master/test/jasmine.json |
I stumbled upon a brilliant open source, multi-lingual, multi-dev-environment guide for first contributors that we could link to in our contribution guide: https://github.com/firstcontributions/first-contributions It includes How-Tos for
@TomWFox what's your opinion as chief docs officer? |
Looks neat, there are some parts which wouldn't apply for our projects (e.g. make changes - could cause a bit of confusion but perhaps easily outweighed by the benefit of the resource). |
I would be happy to work on it! |
Great! In terms of modification, it should transition from its current form of anecdotal account to a neutral guide:
To not just add more content to the contribution guide, we should create a structure that provides an index with overview and allows to deep dive when necessary. For example, the first thing in the contribution guide should be a simple index that links into the respective document section, like:
As part of the change, a lot of the current technical instructions should be added only as alternative info, such as git CLI commands. For new developers git CLI commands are not necessary, they can use GutHub Desktop and experienced developers don't need to be instructed on how to use the git CLI anyway. |
New Issue Checklist
Issue Description
The Contribution Guide could benefit from an overhaul to:
The contribution guide currently only contains descriptions of the technical set-up required to make changes to Parse Server, described in way that assumes a level of pre-existing knowledge about tools and processes that has shown in some cases to discourage new developers from creating PRs. Parse is not just an entry point for new developers for its use as a backend but also when it comes to its development and making first steps into open-source contribution. A more accessible guide benefits both developers and further development of Parse.
Suggested changes
Please feel free to grab one or propose others.
The text was updated successfully, but these errors were encountered: