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.

Sign up for GitHub

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

Jump to bottom

Improve readability #116

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

Improve readability #116

wants to merge 6 commits into from

Conversation

suiso67
Copy link

@suiso67 suiso67 commented Sep 3, 2023

Purpose

  • This PR refactors existing code base for readability
  • This PR doesn't change any existing functionalities

Features

General

  • Replace whitespaces with tab characters when appropriate
  • Remove unnecessary/self-explanatory comments

Rename functions and variables

  • Give more context
  • Use camel-case for functions and variables
  • Use snake-case for constants
  • Remove side-effects from functions
    • Some functions were doing more than what they say

Misc

  • Fix broken alignment in config.h
  • Move vim auto-compilation instruction into README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@suiso67