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

Clean up root directory #2881

Merged
merged 1 commit into from Nov 26, 2021
Merged

Conversation

tomaarsen
Copy link
Member

@tomaarsen tomaarsen commented Nov 8, 2021

Hello!

Pull request overview

  • Attempt to clean up the root directory somewhat.

The cleanup

I've already deleted .travis.yml, jenkins-job-config.xml and jenkins.sh from the root in this PR, as we no longer use these files. If we ever decide to return to these services (which I doubt greatly), then we can always just look in the git history to find them again.

There are also jenkins and travis specific files elsewhere, specifically under tools/travis and tools/jenkins, but these files aren't really "in the way" as much. That said, I'm open to also deleting these.

Other files

There are some other files in the root directory which might be somewhat unnecessary:

  • Perhaps we can merge requirements-test.txt and requirements-ci.txt. They're both for testing, and are already very similar.
  • I'm not sure whether NOTICE.txt and INSTALL.txt provide much at this point - I don't know why these are explicit files, instead of being a part of the README or something similar.
  • It somewhat bothers me that pip-req.txt and requirements-ci.txt/requirements-test.txt don't have the same naming structure. Perhaps we can change this? (To be honest, I don't remember ever seeing a pip-req.txt file before NLTK - I only encounter requirements.txt)

  • Tom Aarsen

@iliakur
Copy link
Contributor

@iliakur iliakur commented Nov 9, 2021

+1 for deleting jenkins/travis tooling. As you said, we have version control in case we want to do some time-travel. In the unlikely event that we return to those services, though, I suspect we'll have to start from scratch anyway due to changes having accumulated since those files were written.

In general +1 for deleting anything that's not absolutely necessary. The catch is ofc figuring out what absolutely necessary is. For things like NOTICE and INSTALL, I'd ask around (slack, mailing list) if anyone needs those for whatever reason. I'm not sure everyone follows github that closely.

As for all the requirements.txt files, maybe #2836 is the right place to discuss that? For example, if we switch to Poetry (tbh my personal preference), we likely won't need any requirements.txt at all.

@stevenbird
Copy link
Member

@stevenbird stevenbird commented Nov 12, 2021

Glad for this cleanup... thanks for thinking of it, and I hope its not too hard to work out which of those other files can go away now!

@stevenbird stevenbird self-assigned this Nov 18, 2021
@stevenbird stevenbird merged commit fdde264 into nltk:develop Nov 26, 2021
16 checks passed
stevenbird added a commit that referenced this issue Nov 26, 2021
Redundant file, cf #2881
stevenbird added a commit that referenced this issue Nov 26, 2021
Removed unnecessary file, cf #2881
@tomaarsen tomaarsen deleted the enhancement/root-cleanup branch Nov 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants