Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and enhance README file(s) #272

Open
bockthom opened this issue Oct 23, 2024 · 0 comments
Open

Update and enhance README file(s) #272

bockthom opened this issue Oct 23, 2024 · 0 comments
Milestone

Comments

@bockthom
Copy link
Collaborator

(1) I just noticed that our README file still points to the already archived version of siemens/codeface.
I suggest to replace the outdated pointer by a link to se-sic/codeface (but adding a comment that codeface was originally developed by Siemens).

(2) In addition, it might be useful to state which data of the main data sources (commits, mails, issues) can be extracted by which tool (e.g., by adding a link to the respective tool, such as codeface or GitHubWrapper). However, I am not sure where to add this information. As coronet relies on codeface-extraction instead of directly using the outcomes of the different tools, maybe the README of codeface-extraction would be more suited to that, and we can just point to the codeface-extraction in the README of coronet for further reading upon how to extract data from the different main data sources.

@hechtlC: What do you think?

I would like to fix part (1) ASAP; part (2) is not as urgent.

@bockthom bockthom added this to the v4.5 milestone Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant