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

Investigate renaming copying.txt to LICENSE.md for GitHub license detection #17621

Open
coderabbitai bot opened this issue Jan 14, 2025 · 20 comments
Open
Labels
p5 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority triaged Has been triaged, issue is waiting for implementation.

Comments

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Currently, the NVDA license is stored in copying.txt. GitHub has built-in license detection that automatically identifies repository licenses when they follow common naming patterns like LICENSE.md.

Consider renaming copying.txt to LICENSE.md to:

  • Improve repository license visibility on GitHub
  • Follow modern open source conventions
  • Make the license more discoverable for new contributors

Related PR: #17600 where license file handling was updated.

Note: This change requires careful consideration of:

  • Impact on existing documentation/scripts that might reference copying.txt
  • Migration plan for existing installations
  • Update of any hardcoded references to the file name
@LeonarddeR
Copy link
Collaborator

@coderabbitai could you scan the repository and provide a list of files where copying.txt is mentioned? May be you could even come up with a script that allows us to automatically do this rename?

This comment has been minimized.

@LeonarddeR
Copy link
Collaborator

LeonarddeR commented Jan 14, 2025

@coderabbitai yes, please test it

This comment has been minimized.

@LeonarddeR
Copy link
Collaborator

@coderabbitai many files have something like this in their header: See the file COPYING for more details. They mention COPYING, not copying.txt, could you also deal with that?

This comment has been minimized.

@LeonarddeR
Copy link
Collaborator

LeonarddeR commented Jan 14, 2025

@coderabbitai please test this thoroughly first. Please also avoid changing stuff in user_docs/*, other than user_docs/en/*.md

This comment has been minimized.

This comment has been minimized.

@LeonarddeR
Copy link
Collaborator

@coderabbitai I don't think any md file contains the See the file COPYING text, could you confirm that and avoid checking md files in source and tests directories?

This comment has been minimized.

@LeonarddeR
Copy link
Collaborator

@coderabbitai your checks re user_docs is not correct, as there are no references to blob/master in user_docs. Please perform a new scan of occurrence of copying.txt across the repo and rewrite the script accordingly.

This comment has been minimized.

@LeonarddeR
Copy link
Collaborator

@coderabbitai ok, just leave out user_docs

This comment has been minimized.

@seanbudd
Copy link
Member

I think renaming to just COPYING has the same affect in GitHub and less work

@LeonarddeR
Copy link
Collaborator

I don't see ``COPYING` mentioned as an accepted alternative here

@seanbudd
Copy link
Member

seanbudd commented Jan 15, 2025

@LeonarddeR - seems to work for e-speak
https://github.com/espeak-ng/espeak-ng

@gerald-hartig
Copy link
Collaborator

@LeonarddeR please consider using your own instance of coderabbit for conversations such as these as otherwise this creates a lot of email noise and consumes up our usage tokens.

@gerald-hartig gerald-hartig added p5 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority triaged Has been triaged, issue is waiting for implementation. labels Jan 20, 2025
@LeonarddeR
Copy link
Collaborator

@gerald-hartig I'm sorry for the inconvenience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p5 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority triaged Has been triaged, issue is waiting for implementation.
Projects
None yet
Development

No branches or pull requests

3 participants