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

fix: remove executable permissions from README #1253

Merged
merged 1 commit into from
Aug 25, 2023

Conversation

MichaelBergquistSuarez
Copy link
Contributor

@MichaelBergquistSuarez MichaelBergquistSuarez commented Aug 25, 2023

Description

I removed the executable permission from README.md

Motivation and Context

Having a executable README feels like a security risk.

Especially since .md files tend to start with same "#" as executable shebangs.

It looks like it was made executable in 7e2f534

I can see no reason for it to be executable, since it is a markdown file and not a script that contains code that should be executed.

How has this been tested?

find . -executable | grep ".md"
echo "$?"
# Result: 0

Screenshots (if appropriate)

Types of changes

Changes visible to users:

  • Bug fix (prefix: fix - non-breaking change which fixes an issue)
  • New feature (prefix: feat - non-breaking change which adds functionality)
  • Breaking change (prefix: feat!! or fix!! - fix or feature that would cause existing functionality to not work as expected)
  • Documentation (prefix: docs - improvements to any documentation content for users)
  • Homepage (prefix: page - improvements to the Homepage #{HOMEPAGE} should lead to the place where one could actually change the homepage
  • Contributing Guidelines (prefix: contrib - any improvements to documentation content for contributors - see Contributing

Internal changes:

  • Refactor (prefix: refactor - non-breaking change which only improves the design or structure of existing code, and making no changes to its external behaviour)
  • Tests (prefix: test - additions and improvements to unit tests and the smoke tests)
  • Infrastructure (prefix: chore - examples include GitHub Actions, issue templates)

Checklist

  • My code follows the code style of this project and passes npm run lint.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly. # {DOCUMENTATION} <------- this should lead to the doc that could be changed/ didnt find it
  • My change has adequate Unit Test coverage.

Terms

- Feels risky. Especially since .md files tend to start with same "#" as executable shebangs
- It was made executable in 7e2f534
@vercel
Copy link

vercel bot commented Aug 25, 2023

@MichaelBergquistSuarez is attempting to deploy a commit to the reworkd Team on Vercel.

A member of the Team first needs to authorize it.

@ergomake
Copy link

ergomake bot commented Aug 25, 2023

Hi 👋

Here's a preview environment 🚀

https://next-reworkd-agentgpt-1253.env.ergomake.link

Environment Summary 📑

Container Source URL
next Dockerfile https://next-reworkd-agentgpt-1253.env.ergomake.link
docs Dockerfile https://docs-reworkd-agentgpt-1253.env.ergomake.link
platform Dockerfile https://platform-reworkd-agentgpt-1253.env.ergomake.link
db Dockerfile [not exposed - internal service]
weaviate semitechnologies/weaviate:1.19.6 https://weaviate-reworkd-agentgpt-1253.env.ergomake.link

Here are your environment's logs.

For questions or comments, join Discord.

Click here to disable Ergomake.

@awtkns
Copy link
Contributor

awtkns commented Aug 25, 2023

Thanks for the detailed write up! Good catch!

@awtkns awtkns merged commit f11b0d9 into reworkd:main Aug 25, 2023
1 of 2 checks passed
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