Closed kylie-taitano closed 12 months ago
That's a good point. These files don't belong in the published repo. That was more of an artifact of copying the repo into the Replit and onboarding for volunteers. I can remove it from the Replit but we'll have to do that every time we push updates to the original codebase. I'm not sure if it's worth the hassle to delete this every time or to just update it and specify that this file is for "volunteers." The .github
files should also be hidden by default on Replit. We can probably fix this by making a separate branch, public
which we then save and send to Replit or whatever medium we're using.
On this note, we should also consider:
.git
versioning in the published ReplitWe make a new branch that reflects
main
except it is missing the developer files {contributions.md
,/.github
, etc.}. This allows us to follow git-flow methodology. I would recommend we buildpublic
as our primary release branch and we usemain
as our developer branch.
.ZIP
fileIn a local copy, we remove the developer files, compress and zip up the files, then package it as a release. This ensures that we don't make accidental changes to releases. This also makes it more obvious when we have a working version.
We take advantage of both. The only con is that we just do the work of both. I recommend this option so that future versions of this tutorial can simply download a previous release and follow-along.
End of the day, the extra files probably won't be investigated at much if at all. If we decide to privatize the codebase, then the repo link will break but that's all.
About
I think it's awesome that we're encouraging the participants to pursue a further interest in code contribution to the website source, but it feels like the Contributing.MD and .github folder is out of place in Replit. For anyone that wants to open contribute, I think a link to this repo in the README should suffice as this repo already contains the files needed.
Resources
Expected result
Additional Notes