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 emacs instructions #258

Merged
merged 2 commits into from
Dec 3, 2024
Merged

Conversation

mmahmoudian
Copy link
Contributor

Description

This PR contains the following in 2 commits:

  1. fixing numerous typos
  2. capitalizing Emacs word when it is not in the code
  3. defining code-fence language for the code blocks to enable syntax highlighting

P.s: As for the commit messages, I tried to look-up previous commit messages and picked the style that I though is correct. Turned out (base on the next session of this PR template), I should have used fix(docs) instead of improve(docs). I hope the current messages are up to your standards. If not let me know, and I will invest some time to delete the branch and create commits with the other prefix. If that's the case, please provide me with the commit message I should use to avoid similar mistake :)

Type of Change

Changes in docs (docs)

  • improve(docs) - e.g. added a new paragraph, example, using a better wording, adding a new document, etc.
  • 🛠️ fix(docs) - bug fix, e.g. fix a typo, page render issue
  • BREAKING CHANGE(docs) - e.g. removing a document/article/category that was referenced in many other places
  • 🧹 refactor(docs) - changed a code example, e.g. replaced old code with a modern one
  • 🗑️ chore(docs) - other changes that don't affect the docs, e.g. updating the CI/CD pipeline

Changes in the platform (platform)

  • feat(platform) - a new feature, e.g. a new MDX component, plugin, theme, etc.
  • 🛠️ fix(platform) - bug fix, e.g. fix a typo, issue causing component to crash
  • BREAKING CHANGE(platform) - e.g. removing a feature, changing the API, etc.
  • 🧹 refactor(platform) - code improvements, changes, e.g. unifying style, renaming internals, etc.
  • 📝 docs(platform) - updated code documentation
  • 🗑️ chore(platform) - other changes that don't affect the platform directly, e.g. updating the CI/CD pipeline

@Dich0tomy
Copy link
Collaborator

LGTM! Thank you! :)

@Dich0tomy Dich0tomy merged commit ecc53bd into Cpp4You:main Dec 3, 2024
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