search

callahantiff / Abra-Collaboratory

git reproducible - version control your ideas
GNU General Public License v3.0
6 stars 5 forks source link

Wiki: Forking is probably not the right way to integrate this #11

Closed tuh8888 closed 5 years ago

tuh8888 commented 5 years ago

Wiki Page:

Suggestions: So far, for my use cases, I have been converting current projects to be Abra-Collaboratory complient projects. To do this, I have used the script proposed in this pull request. This has worked pretty well for the most part. The only time consuming step is the copying of the project boards.

I think the suggested first step of the README (forking the Abra-Collaboratory repository), is not going to be the best way to start a project. Instead, users should create a new repository the standard way (clicking the + button on GitHub). Then copy over resources from Abra-Collaboratory into their project and follow the procedure starting from step 2. For users with current projects, they can skip this step.

magic-lantern commented 5 years ago

I agree with @tuh8888 that the goal is to create a project compliant with the Abra-Collaboratory philosophy. The structure is what we really want; items like the README.md and LICENSE would need to be customized based on the project's needs.

I think that it would be beneficial for the new project creation script to replace the README.md with a template with instructions telling what items are recommended to go in the README.md.

I also agree that the not all the wiki pages should be carried over to a new project. Home should be updated similar the README.md, and pages like the To-Do list would need to be customized. I do however, think it important to keep the ...Reproducible... pages as they have important information that I would want users of my project to know. Replacing the term 'PheKnowVec' with the newly created project would be a good start there rather than removing them.

To me, forking seems easier than copying everything out of the upstream Abra-Collaboratory repository, but if the process is automated, it doesn't really matter how it happens on the backend.

callahantiff commented 5 years ago

@magic-lantern and @tuh8888 I think we have addressed everything here, thanks to the awesome contributions you both made 👏. Unless I am missing something, OK to close this?

magic-lantern commented 5 years ago

I agree this can be closed, but since it was opened by @tuh8888, I'll let them make the final decision.

callahantiff commented 5 years ago

Agree, @tuh8888 please close this issue if you feel it is resolved.