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: update readme, contributing.md, and fix typos #855

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

SethFalco
Copy link
Contributor

@SethFalco SethFalco commented Sep 20, 2022

  • Add an EditorConfig file so it's easier code editor settings don't get in the way while contributing to the project.
  • Fix typos in CONTRIBUTING.md, also the link fragment in one of the URLs was outdated. (setup vs set-up)
  • Docker gives warning about apt vs apt-get, could we just make this user apt-get so we don't have to deal with them? ^-^' (Plus I guess it's better to go the stable API route anyway.)
  • Very minor code change, just removes a redundant import and makes nouns like Discord/Matrix match the proper capitalization.
  • While setting up the bridge, I added the 2 config properties from the README, but then the bot failed to start becasue I had 2 remove those 2 config properties. If they're outdated, I guess they shouldn't be suggested on the README either?
  • Update broken link in comments.

These are all just small things I found while working on #854. I didn't do a CHANGELOG entry intentionally since these are just chores, let me know if you want me to add one anyway.

@SethFalco SethFalco requested a review from a team as a code owner September 20, 2022 19:17
@SethFalco SethFalco changed the title chore: remove deprecated config from readme chore: update readme, contributing.md, and fix typos Sep 20, 2022
@Miepee
Copy link
Contributor

Miepee commented Nov 3, 2022

Docker gives warning about apt vs apt-get

Why does Docker give warnings? AFAIK apt-get is deprecated, so programs should use apt whenever possible

@SethFalco
Copy link
Contributor Author

SethFalco commented Nov 3, 2022

apt-get isn't deprecated!
In scripts, apt will throw a warning because it's not considered a stable interface.

So for scripts/Docker, it's recommended to use apt-get.

https://askubuntu.com/a/829869/938482

Signed-off-by: Seth Falco <seth@falco.fun>
Signed-off-by: Seth Falco <seth@falco.fun>
Signed-off-by: Seth Falco <seth@falco.fun>
Signed-off-by: Seth Falco <seth@falco.fun>
Signed-off-by: Seth Falco <seth@falco.fun>
Signed-off-by: Seth Falco <seth@falco.fun>
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.

2 participants