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

Contributing Blog #31

Merged
merged 6 commits into from
Feb 14, 2021
Merged

Contributing Blog #31

merged 6 commits into from
Feb 14, 2021

Conversation

dblythy
Copy link
Member

@dblythy dblythy commented Dec 16, 2020

@mtrezza the reason I worked on 7078, thought the walkthrough could help some people.

Tried to keep it informal so contributors know that they can always ask for questions and help. But can re-write in a different format.

Reminding you all that I am a noob too so pls correct my terminology if it's incorrect.

Will review typos tomorrow.

@mtrezza
Copy link
Member

mtrezza commented Dec 16, 2020

I haven't thought about it that way, but now I get what you were up to. A blog article from a "new developer" to other new developers about your contributing experience (even though I personally consider you being an old hand at contributing rather than a new developer 😉).

A nice idea! It could encourage others to contribute. @TomWFox what do you think?

I can't really see the blog post content on mobile, but maybe we can re-use some of the text for the new contribution guide.

Maybe we want to wait with review and merging until we overhauled the contribution guide with parse-community/parse-server#7075, if that makes sense? We may then also link the blog post in the new contribution guide.

@TomWFox
Copy link
Contributor

TomWFox commented Dec 16, 2020

Love the idea!

@dblythy
Copy link
Member Author

dblythy commented Dec 17, 2020

Thanks lads. The main motivation is to highlight that even regular contributors like myself still need to ask for help, and sometimes need help with creating features. I found contributing rather intimidating at first considering this is the first package I’ve contributed to, so I guess the intent is to try to let new developers know that it’s okay to not know everything.

I chose the afterFind issue as I figure it’s not an overly complicated new feature conceptualisation, just a simple bug. As you’ve said in the past @mtrezza, there are a lot of these that remain unfixed mostly because the reporter has never contributed before. I would be more than happy to try to continue to encourage / support new developers in contributing.

@mtrezza
Copy link
Member

mtrezza commented Dec 17, 2020

I would be more than happy to try to continue to encourage / support new developers in contributing.

That's great, every help in parse-community/parse-server#7075 would be appreciated.

Base automatically changed from master to main January 26, 2021 20:02
@TomWFox
Copy link
Contributor

TomWFox commented Feb 13, 2021

Now parse-community/parse-server#7075 has been merged shall we move forward with this post?

_config.yml Show resolved Hide resolved
@mtrezza
Copy link
Member

mtrezza commented Feb 13, 2021

Two points:

  • I think this is a great blog post that also deserves a more formalized, "unpersonalized" version of it to be added to the contribution guide. The difference being that only then it becomes a community maintained document of instruction and also gets a more public forum and presumably higher usage than this blog post.
  • As such, this is your personal tale that describes how you solved a particular bug, which is an interesting angle to read and fine as it is. For the formal version however, I see some important approaches and hints missing. For example, how to attach the debugger to a test to inspect the code, look at call stack, etc. I am not suggesting to add this (and more) to your blog post, because it would not be an authentic account of your experience anymore. But I think for the formal version we have some things to add.

Good to publish I'd say 👍

@mtrezza
Copy link
Member

mtrezza commented Feb 13, 2021

This should be a PR though, not a direct main branch merge? I also changed this in the branch permissions, in accordance to our other repos.

@TomWFox
Copy link
Contributor

TomWFox commented Feb 13, 2021

This should be a PR though, not a direct main branch merge? I also changed this in the branch permissions, in accordance to our other repos.

Could you elaborate? This is a PR 🧐

@mtrezza
Copy link
Member

mtrezza commented Feb 13, 2021

Yes it is a PR, but the change was not made on a feature branch but on a forked main branch. It makes sense to disallow this for git reasons. I disallowed this in the repo settings:

image

Now that I think about it, I am not sure whether a forked main is also considered a feature branch for this setting 🧐

Copy link
Contributor

@TomWFox TomWFox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Did you run it locally to check it's rendering ok? I've been trying and failing.

_posts/2020-12-16-Contributing-to-Parse-Server.md Outdated Show resolved Hide resolved
@TomWFox
Copy link
Contributor

TomWFox commented Feb 14, 2021

Yes it is a PR, but the change was not made on a feature branch but on a forked main branch. It makes sense to disallow this for git reasons. I disallowed this in the repo settings:

image

Now that I think about it, I am not sure whether a forked main is also considered a feature branch for this setting 🧐

Pretty certain that you can use whatever branch you like when it's a fork. But good to have turned it on.

@dblythy
Copy link
Member Author

dblythy commented Feb 14, 2021

For example, how to attach the debugger to a test to inspect the code, look at call stack, etc.

This probably highlights the importance of a formal version because the reason I haven't added it is because I don't know how to do it myself. I normally just set silent to false in helper.js, which isn't ideal. I think though if this is going to be a point of reference for new contributors we should be introducing best practices?

@mtrezza
Copy link
Member

mtrezza commented Feb 14, 2021

I think though if this is going to be a point of reference for new contributors we should be introducing best practices?

In a formal version we should add this and more, but your blog post is fine as it is IMO, but feel free to add if you like. I think your post is a good entry point and easily digestible. I see it more as an anecdote. That's why I separated the blog post from the official documentation in my earlier comment.

@TomWFox
Copy link
Contributor

TomWFox commented Feb 14, 2021

Just to add, in future if you want, editing a blog post is as simple as editing the file.

@TomWFox
Copy link
Contributor

TomWFox commented Feb 14, 2021

I managed to run the site locally, for some reason it was stuck on a 'yanked' version of jekyll-paginate-v2, but anyway it looks all good.

@dblythy I'm happy to publish if you are? I've bumped the date today.

@dblythy
Copy link
Member Author

dblythy commented Feb 14, 2021

Happy to go if you are mate.

@TomWFox TomWFox merged commit 29488c2 into parse-community:main Feb 14, 2021
@TomWFox
Copy link
Contributor

TomWFox commented Feb 14, 2021

I'll tweet it from @ParsePlatform later 🚀

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

Successfully merging this pull request may close these issues.

3 participants