Skip to content

Comments

feat: Add .editorconfig file with code formatting rules#1

Merged
searge merged 11 commits intodevelopfrom
searge
Nov 5, 2023
Merged

feat: Add .editorconfig file with code formatting rules#1
searge merged 11 commits intodevelopfrom
searge

Conversation

@searge
Copy link
Contributor

@searge searge commented Nov 5, 2023

Transfer images to docs

Editorconfig

  • Adds a new file .editorconfig with standard code formatting rules using UTF-8 encoding, inserting final newline, and trimming trailing whitespace.
  • Defines indentation styles and sizes for different file types to ensure consistent formatting.
  • Uses space indentation for most file types except for specific ones like Makefile, go files, and Markdown files which use tab indentation and have different indentation sizes.
  • Sets indent_size to 4 for Dockerfile.
  • Overall, this commit enhances code consistency and readability.

Refactor: Update README.md with detailed features and specifications

  • Updates the project overview and adds extensive descriptions for each feature and functionality of the GeekBot Telegram bot.

  • Includes details on new member verification, moderation automation, reward system, point redemption, and community rule enforcement.

  • Provides visual representation of community merch in the README.

  • Adds a section on the technical specifications, stack, and tooling used in the development of the GeekBot.

  • Includes a list of study materials for learning Go.

    Note: The README file was not properly formatted, but it has been fixed in this commit.

  • feat: Add initial root command implementation

This commit adds the initial implementation of the root command, which represents the base command when called without any subcommands. The root command has a short description of the application and a longer description that provides examples and usage of the application. It also defines a "toggle" flag as a local flag for the root command. Additionally, this commit includes the addition of the go.mod and go.sum files, which specify the Go module and its required indirect dependencies. Finally, the main.go file is modified to import and execute the root command.

  • Add Universal Linux dev container config

This commit adds the configuration file for the Universal Linux dev container. It includes references to various features such as kubectl, Helm, Minikube, Node.js, Vim, and k3d. Uncommented lines provide additional customization options like postCreateCommand and the ability to connect as root. For more details, please refer to the README documentation.

- Adds a new file `.editorconfig` with standard code formatting rules using UTF-8 encoding, inserting final newline, and trimming trailing whitespace.
- Defines indentation styles and sizes for different file types to ensure consistent formatting.
- Uses `space` indentation for most file types except for specific ones like Makefile, go files, and Markdown files which use `tab` indentation and have different indentation sizes.
- Sets `indent_size` to 4 for Dockerfile.
- Overall, this commit enhances code consistency and readability.

Refactor: Update README.md with detailed features and specifications

- Updates the project overview and adds extensive descriptions for each feature and functionality of the GeekBot Telegram bot.
- Includes details on new member verification, moderation automation, reward system, point redemption, and community rule enforcement.
- Provides visual representation of community merch in the README.
- Adds a section on the technical specifications, stack, and tooling used in the development of the GeekBot.
- Includes a list of study materials for learning Go.

Note: The README file was not properly formatted, but it has been fixed in this commit.
The code changes update the image display in the README.md file to use flexbox with equal space distribution.
@searge searge requested a review from vanelin November 5, 2023 14:09
@searge searge added the enhancement New feature or request label Nov 5, 2023
This commit adds a Markdownlint workflow in `.github/workflows/mardownlint.yml` to perform linting on Markdown files in the `docs` directory. The workflow runs on both push and pull request events for the `main` and `develop` branches. It utilizes the `actions/checkout@v3` action to clone the repository and the `articulate/actions-markdownlint@v1` action to perform the linting. The configuration file used is `markdownlint-config.json` and it lints all Markdown files except those in the `node_modules` directory. The version of Markdownlint used is `0.28.1`.
This commit adds the initial implementation of the root command, which represents the base command when called without any subcommands. The root command has a short description of the application and a longer description that provides examples and usage of the application. It also defines a "toggle" flag as a local flag for the root command. Additionally, this commit includes the addition of the go.mod and go.sum files, which specify the Go module and its required indirect dependencies. Finally, the main.go file is modified to import and execute the root command.
This commit adds the configuration file for the Universal Linux dev container. It includes references to various features such as kubectl, Helm, Minikube, Node.js, Vim, and k3d. Uncommented lines provide additional customization options like postCreateCommand and the ability to connect as root. For more details, please refer to the README documentation.
@searge searge merged commit 3e2aa0b into develop Nov 5, 2023
@searge searge deleted the searge branch November 5, 2023 15:38
searge added a commit that referenced this pull request Nov 12, 2023
* 🚚 Transfer images to docs

* feat: Add .editorconfig file with code formatting rules

- Adds a new file `.editorconfig` with standard code formatting rules using UTF-8 encoding, inserting final newline, and trimming trailing whitespace.
- Defines indentation styles and sizes for different file types to ensure consistent formatting.
- Uses `space` indentation for most file types except for specific ones like Makefile, go files, and Markdown files which use `tab` indentation and have different indentation sizes.
- Sets `indent_size` to 4 for Dockerfile.
- Overall, this commit enhances code consistency and readability.

Refactor: Update README.md with detailed features and specifications

- Updates the project overview and adds extensive descriptions for each feature and functionality of the GeekBot Telegram bot.
- Includes details on new member verification, moderation automation, reward system, point redemption, and community rule enforcement.
- Provides visual representation of community merch in the README.
- Adds a section on the technical specifications, stack, and tooling used in the development of the GeekBot.
- Includes a list of study materials for learning Go.

Note: The README file was not properly formatted, but it has been fixed in this commit.

* feat: Add initial root command implementation

This commit adds the initial implementation of the root command, which represents the base command when called without any subcommands. The root command has a short description of the application and a longer description that provides examples and usage of the application. It also defines a "toggle" flag as a local flag for the root command. Additionally, this commit includes the addition of the go.mod and go.sum files, which specify the Go module and its required indirect dependencies. Finally, the main.go file is modified to import and execute the root command.

* Add Universal Linux dev container config

This commit adds the configuration file for the Universal Linux dev container. It includes references to various features such as kubectl, Helm, Minikube, Node.js, Vim, and k3d. Uncommented lines provide additional customization options like postCreateCommand and the ability to connect as root. For more details, please refer to the README documentation.
searge added a commit that referenced this pull request Nov 12, 2023
searge added a commit that referenced this pull request Nov 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant