You mean a README in the virtualstoics.github.io repository? Or do you mean the “projects” tab? Sorry, still figuring this out. But I’ve posted here, and hopefully explained correctly. Will get on that! Thank you @RandellDawson, if you have time, and feel like giving some more pointers(like you have above), it’d be much appreciated.
username1001, I would love to help. Not sure how to exchange the email because we will chat on the phone.
How do I reach out to you?
Yes, my username is the same. I will email you sometimes today. You can remove your email out if you want. I already copied it.
Ok, cool. I sent you an invitation. You should have an email waiting for you. Looking forward to hearing from you!
I added a contributing.md to a recent open source group project for our local (Melbourne) freeCodeCamp group.
I recommend you add one of those so that people know how to contribute. (Steal mine and change the links if you like )
Since this is a greenfield project (i.e. you’re making it from scratch together), you should at a minimum put together a To-Do list of jobs that need to be done, so people have a sense of what you’re making.
Even better, create extensive User Stories, and use the GitHub projects Kanban style board to set out the road map of work to be completed.
New projects are exciting, but you’ll benefit from a good structure at the start to steer you in the right direction.
Indeed, it’ll definitely need one of those, haha. Considering @RandellDawson’s reply, the post is premature; I wish I would have waited until things were more “ready”, and thought out.
Thank you for offering the README, your post is greatly appreciated!
From the purpose of my learning, I don’t think this is premature at all. Good to see the steps that others are recommending you make. I’ll definitely be following along as each new step gets documented.
That’s what I initially thought as well. I mean, that is why I created this, that is, to be a learning tool. I think the forum I have in mind may gather a decent amount of users(I posted about it in a Facebook group, and quite a few people messaged me saying they’d love it), which would be great, I think. Creating a real-world application that is actually used by a lot of people, just lands us closer to our goals, and in itself, is an awesome thing to accomplish. However, that isn’t the end-goal. The goal is to learn and build together. Whether or not people actually use any of the projects is a secondary concern.
Sorry for writing all of that unsolicited text, but I thought it might be useful for potential contributors. I agree that the advice of other people so far was great, definitely worth following along, haha.
Just to clarify, Randell’s suggestion for a README was good, but that serves a slightly different purpose to a CONTRIBUTING document.
Typically, the README is to tell users how to use the product. Usually you see them on NPM modules or frameworks, explaining the API. Your forum idea might just have a README that explains the purpose of the forum, and if it’s a standalone piece of forum software you might include hosting instructions for those that wanted to clone it.
The CONTRIBUTING document is to tell contributors how to get involved. So that includes instructions for cloning the repo, how to format pull requests, and any requirements you have (such as using a specific ESlint config, or to ensure tests pass before PRs etc…)
Yes, I’ve added both. Used your CONTRIBUTING.md I’ve linked your github, and the original repository which it’s from in the “attribution” section. I hope you don’t mind! Thanks again, @JacksonBates
If you don’t want to manually send invites for ever, you can use a free service like OrgManager to do so
I just realized the name Miguel in the URL. Did you create this??
@JacksonBates, I’d like to know to, honestly. I just gave admin access to my organization
Yeah - I run an org to, and want to know how this processes my orgs data without compromising the privacy or safety of my volunteers…hence my question
Same concerns as you, haha. I see familiar faces in the OrgManager project.
I found this:
“OrgManager takes Github Organizations to a new level! We require the org:admin permission to send invites to your users, but remember that you can revoke that permission when you want, and that we won’t do anything without your permission.”
@m1guelpf, What does it mean by “send invites to your users”? Do we already need users?
I’d like to know to, honestly. I just gave admin access to my organization
I run an org to, and want to know how this processes my orgs data without compromising the privacy or safety of my volunteers…hence my question
First, if you don’t want to trust your data blindly to the app (something that I wouldn’t do ) the app is OSS, so you can check the code here.
Could you explain what it does exactly?
OrgManager allows you to create a “portal” where users can apply to your GitHub org and be auto-invited, or you can also set a password.
Did you create this??
I guess I’ll trust it. Your extensive github use, membership of reputable orgs, it’s OSS, etc. lead me to trust… Which really might not be good… this is how people get pwned, lol.
So we don’t need users? How does it work, and can a user of the project join other organizations, as well allow people to join theirs?
Yeah, I’m in 3 orgs myself.
It makes it easier to assign someone to work on a feature if they are in your org, among other things.