git-utilities / fix_logs

Simple Python script that attempts to fix Git logs automatically.
https://git-utilities.github.io/fix_logs/
GNU Affero General Public License v3.0
0 stars 0 forks source link

What repositories need added to default config.json? #1

Open S0AndS0 opened 4 years ago

S0AndS0 commented 4 years ago

To help @llSourcell fix Git logs, the current config.json file contains entries similar to...

Update notice, 57 repositories are now within the default config.json file the following example configurations are left as is for brevity.

{
  "fixed": "./fixed.json",
  "failed": "./failed.json",
  "defaults": {
    "origin_branch": "master",
    "origin_remote": "origin",
    "source_branch": "master",
    "source_remote": "source",
    "fix_branch": "fix",
    "fix_commit": "Fixes logs",
    "keep_fix_branch": false,
    "no_push": false
  },
  "repos": [
    {
      "dir": "~/git/hub/llSourcell/Bitcoin_Trading_Bot",
      "source": "https://github.com/jaungiers/Multidimensional-LSTM-BitCoin-Time-Series.git"
    },
    {
      "dir": "~/git/hub/llSourcell/How-to-Predict-Stock-Prices-Easily-Demo",
      "source": "git@github.com:jaungiers/LSTM-Neural-Network-for-Time-Series-Prediction.git"
    },
    {
      "dir": "~/git/hub/llSourcell/How_to_simulate_a_self_driving_car",
      "source": "git@github.com:naokishibuya/car-behavioral-cloning.git"
    }
  ]
}

... there are likely more repositories that can be added to automated fixing of Git logs.

If you're willing to help track these repositories down then please either list them as a response to this Issue, or via a Pull Request to the default config.json file.

When adding to this list it would be very kind if you could also notate any extra commands required.


Example

git mv ./main.py ./demo.py

This will help with directing future feature developments of the fix_logs project; currently I'm contemplating adding options such as...

{
  "dir": "~/git/hub/llSourcell/How_to_simulate_a_self_driving_car",
  "source": "git@github.com:naokishibuya/car-behavioral-cloning.git",
  "git_commands": {
    "after_checkout": ["mv", "./main.py", "./demo.py"]
  }
}

... to better facilitate fixing Git logs in an automated fashion.

S0AndS0 commented 4 years ago

The config.json file has been updated with repositories that could be easily parsed for source URLs. the following lists those that could be found that require special attention and/or actions to correct.


Missing Source Repository

If the source is found then please add it to either the config.json file via Pull Request, or by adding to this Issue


Unlicensed Source Repositories

By default most works are considered "All rights reserved" when unlicensed! GitHub ToS may read as though there is room to wiggle in regards to those that Fork properly, however, it is probably best to investigate further. The OpenSource StackExchange -- How does GitHub's "forking right" cope with an "All rights reserved" project question may be worth reading too.


Requires Manual Corrections

Some are non-GitHub sources, others are from Gists, all cannot be automatically merged via this project currently.


Second Opinion Needed... Maybe

Not certain how to classify these, some or all may be okay as is, but probably best that their double checked to ensure that nothing is amiss


Missing ReadMe

Sources, if any will require searching for.


Requires re-Parsing

Seems that three repositories where missed on first-pass when searching for ReadMe files.

llSourcell commented 4 years ago

hey, thanks so much for taking the time to compile this. If i can easily fix all my repos with a few commands to properly credit the authors, I will readily do that. The problem is if i have to manually go through all of them, that's going to be so much work. Can you please create a step by step tutorial on what i should do via command line to make that happen?

S0AndS0 commented 4 years ago

@llSourcell hey, thanks so much for taking the time to compile this. If i can easily fix all my repos with a few commands to properly credit the authors, I will readily do that. The problem is if i have to manually go through all of them, that's going to be so much work. Can you please create a step by step tutorial on what i should do via command line to make that happen?


Welcome as always.

Currently this project is focused on correcting things that if left as is could lead to DMCA takedowns being issued, or worse. Reinstating original licenses and injecting commit history from original authors seems to be the simplest way of avoiding such futures.

Not every repository explicitly states that accreditation is a requirement. So language processing may be able to help with marking repositories that require that any further credits, however, with my level of Machine Learning ignorance I'd likely resort to writing in-eloquent regex search patterns. Once marked though I'd be happy to help with writing a script and/or template that can append information to ReadMe files in an automated fashion.

The main ReadMe file of this project has a Quick Start section that in the meantime may be of use, but I'll be certain to write a more detailed guide in the near future. What is the best way to notify you when it's ready for review?