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

chore: cleanup root dir #38

Closed
wants to merge 1 commit into from
Closed

chore: cleanup root dir #38

wants to merge 1 commit into from

Conversation

marcoscaceres
Copy link
Member

Now that this is auto-published, we don't need the .sh files.

Additionally, some of the other files can live in the .github folder, and Github does the right thing. 🪄

@yoavweiss
Copy link
Contributor

Thanks for cleaning up! RE the renaming to .github/, wouldn't that make those files less prominent for contributors?

@marcoscaceres
Copy link
Member Author

wouldn't that make those files less prominent for contributors?

It depends. Github automatically presents the appropriate information from each when a pull request is made.
For example, when opening an issue or pull request (in blue below):

Screen Shot 2021-06-25 at 11 51 32 am

However, it does no harm leaving them in the root, as Github will use those files to generate the above from either location (and anyone browsing the repo can spot them from the root).

In other words, your call :)

@yoavweiss
Copy link
Contributor

Let's leave them at the root then, as it seems more discoverable.

@marcoscaceres
Copy link
Member Author

Sounds good. Closing.

@plehegar plehegar deleted the cleanup branch June 29, 2021 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants