-
Notifications
You must be signed in to change notification settings - Fork 399
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
refactor/3052 refactor to avoid having too many files in root #3053
refactor/3052 refactor to avoid having too many files in root #3053
Conversation
@frascuchon we don't need to forget to set the read the docs config path to |
I tried to move the quickstart docker files to the |
As an easy step, what we can do is move all docker stuff (composes and dockerfiles) to a docker folder. Also, we can remove the commitlint configuration (since we're managing the changelog manually) and maybe the simpler ones to the .github folder too (README.md, CODE_OF_CONDUCT.md, LICENCE...) |
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## develop #3053 +/- ##
===========================================
- Coverage 90.91% 90.54% -0.37%
===========================================
Files 215 208 -7
Lines 11304 11120 -184
===========================================
- Hits 10277 10069 -208
- Misses 1027 1051 +24
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
@frascuchon can you take a look at this PR? |
0b28195
to
f62823c
Compare
@frascuchon I changed the branch to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regarding this doc section, I'm not sure if we should move all those files into the dot-github folder.
It looks like this folder is used for templates and workflow definitions. It's a bit weird for me to find README.md or CHANGELOG.md there, instead of the root one. Even more for the conda environment environment_dev.yml
or the coverage setup (.codecov.yml
)
I would say:
- keep common repo files in the root folder (README.md CHANGELOG, coverage setup, conda env)
- Move al docker stuff into a docker folder and review the required scripts
- Remove unused files as the commitlint.config.js file or some obsolete script (I can take a look here)
Also, I think we should point this PR to the develop
branch, right?
I'm not sure if this checklist can be affected with these changes https://github.com/argilla-io/argilla/community |
chore: added CONTRIBUTING.md
- added a call to action about contacting me or starting a PR - added some default tags to bug and features - added a separate issue for docs
- added UI/UX specific bug template - added a python/deployment bug template - added an integration issue template
77d6c6a
to
47b94ba
Compare
Co-authored-by: Francisco Aranda <francis@argilla.io>
# Description The docker and script have been reviewed: - The docker build context will be placed in the docker folder, so we don't need to change anything inside the dockerfiles - The unneeded scripts have been removed - The specific docker script has been moved into docker/scripts - The scripts used outside docker have been placed in the scripts folder, otherwise, script execution may change. And not much sense to put them inside the docker folder since they are used outside docker images. - Docs have been updated - The `release.Dockerfile` has been renamed to `Dockerfile` (more standard way for the principal docker image) --------- Co-authored-by: davidberenstein1957 <david.m.berenstein@gmail.com>
…-many-files-in-root
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's working. Let's wait until the release branch creation before merging it, just to not disturb the release workflow
7761098
to
49e92ae
Compare
@frascuchon can you show me tomorrow how to resolve these conflicts? |
…-many-files-in-root
Description
Moved some stuff
docker
directoryscripts
directory todocker
directory.github
Closes #3052
Type of change
How Has This Been Tested
N.A.
Checklist
N.A.