Skip to content

AnishKV1230/HAAG-Scripts-Repo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Read Me (How to use the Repository)

Please read all of the information below on the proper procedures for utilizing this repository. The intended flow of scripts is:

Junkyard -> Thrift Shop -> Tested and Documented

Important Tips and Reminders

Most of the workflow can be done from the GitHub web page. When editing a file, you can edit the file path. A couple important notes:

You can add/create a folder within the path by adding a '/' (e. g) "HAAG-Scripts-Repo/"

Junkyard

Scripts here are untested/undocumented and someone needs to pick them for testing/documentation.

Adding Files to Junkyard

First make sure that all relevant files (code, docs, resources, plugins, etc.) are located within one parent folder to represent the whole project/program. Then click 'Add file' next to 'About' then click 'Upload files' then upload the entire parent folder.

All scripts and projects should be uploaded with a parent folder

Picking Up Files

First, navigate to the parent folder of the project you wish to pick up and copy the URL at the top of your browser. Then go to Open https://download-directory.github.io/ and paste the link to download a Zip of that directory.

Ensure that the project was properly downloaded

Navigate back to the parent folder within the repository, click '. . .' and click 'Delete directory' Within the commit message write your name and what project/program you are picking up. For the description write where in the Thrift Shop (or Graveyard) you will move it. Please refer to Adding Files to Thrift Shop or Moving from Junkyard/Thrift Shop to Graveyard to properly add the project to Thrift Shop/Graveyard.

Thrift Shop

Scripts here are currently being tested/documented by the person whose directory the file is in.

Adding Files to Thrift Shop

If you do no have your own directory within Thrift Shop, first open the Thrift Shop folder, click 'Add file' and click 'Create new file' and create some placeholder file within your directory by naming the file somthing like: HAAG-Scripts-Repo/Thrift Shop/GeorgeBurdell/placeholder.txt

Please refer to Picking Up Files to see how to download a project. Now navigate to your directory within Thrift Shop, click 'Add file', then 'Upload files' and/or drag the parent folder into the window.

Working on Thrift Shop files

Navigate to the parent folder for the project you plan to work on and copy the url at the top of your browser. Open https://download-directory.github.io/ and paste the link to download a Zip of that directory. Perform all work locally on your machine.

Saving work to Thrift Shop

Open your directory within Thrift Shop. Click 'Add file' and 'Upload file' and/or just drag the project parent folder into the page. Please include a relevant commit message and description describing what you did. (Dragging the folder into the upload files area is recommended) Double Check the Repository to make sure that the folder organization is correct and that your changes were uploaded If anything is wrong please clean up the folder organization and write that as the commit message. An example folder should be:

Thrift Shop/GeorgeBurdell/TestProject with all project files within.

Tested and Documented

Scripts here have been cleaned, finished, tested, documented, etc. They are organized by the category which they fall under.

Moving from Thrift Shop to Tested and Documented

Navigate to the correct category folder within Tested and Documented for the project (i. e. Tested and Documented/NLP for an NLP project). Click 'Add file' and 'Upload file' and/or just drag the project's parent folder into the page. As part of the commit message and description write that the project is Tested and Documented, including any additional changes you made.

Ensure that the project has been uploaded with proper folder organization and changes

Finally, navigate to the project folder within your subdirectory of Thrift Shop, click '. . .' and click 'Delete directory'. Commit your changes and for the commit message and description write where the project has been moved to within Tested and Documented.

Graveyard

Scripts here have been abandoned for the time being.

Moving from Junkyard/Thrift Shop to Graveyard

Please refer to Picking Up Files to see how to download a project. Now navigate to Graveyard, click 'Add file', then 'Upload files' and/or drag the parent folder into the window.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages