Skip to content

Comments

Update Project Configuration and Documentation#5

Merged
vanelin merged 4 commits intodevelopfrom
searge
Nov 12, 2023
Merged

Update Project Configuration and Documentation#5
vanelin merged 4 commits intodevelopfrom
searge

Conversation

@searge
Copy link
Contributor

@searge searge commented Nov 12, 2023

Description

This Merge Request includes several updates to the project configuration and documentation files. The changes are aimed at improving the overall project structure, configuration consistency, and documentation clarity.

Changes

  1. README.md and Concept Document:

    • Updated information about GeekBot in the README.md file.
    • Added requirements for running the project.
    • Included information about tools and GitHub Actions in the README.md.
    • Introduced a concept document in the plan directory.
  2. Lint Workflow:

    • Modified the lint workflow to include markdown files in the 'docs' directory.
    • Updated lint configuration to use 'markdownlint-config.json'.
  3. EditorConfig and Taskfile.dist.yml:

    • Adjusted indent size to 2 in *.md files in the .editorconfig.
    • Modified Taskfile.dist.yml to include a summary for the 'build' task.

Additional Notes

Please review and merge these changes to enhance the project's consistency and documentation quality. Feel free to reach out if there are any questions or concerns.

Checklist

  • Code review completed
  • Tests passed
  • Documentation updated (if applicable)
  • Ready for merge

- Update information about GeekBot in the README.md file.
- Add requirements for running the project.
- Include information about tools and GitHub Actions in the README.md.
- Add CODE_OF_CONDUCT.md for project code of conduct.
- Add CONTRIBUTING.md with guidelines for contributors.
- Introduce a concept document in the plan directory.
- Modify lint workflow to include markdown files in the 'docs' directory.
- Adjust indent size to 2 in *.md files in the .editorconfig.
- Modify Taskfile.dist.yml to include a summary for the 'build' task.
@searge searge requested a review from vanelin November 12, 2023 08:42
@searge searge self-assigned this Nov 12, 2023
@github-actions
Copy link

Thanks for opening this PR/Issue 🤗
Please wait while the maintainer(s) review it

Fun fact:

clusteringAlgorithmsExplainedByMemes
meme
ℹ️ Source

@searge searge assigned vanelin and mirik12 and unassigned searge Nov 12, 2023
@searge searge added the documentation Improvements or additions to documentation label Nov 12, 2023
@searge searge requested review from Ivasyuk and vitalibit November 12, 2023 08:44
@GeekOpsUA GeekOpsUA deleted a comment from github-actions bot Nov 12, 2023
@searge
Copy link
Contributor Author

searge commented Nov 12, 2023

@vanelin, @mirik12, anyone?

@vanelin vanelin merged commit da7552e into develop Nov 12, 2023
@searge searge deleted the searge branch November 12, 2023 09:18
@searge searge removed the request for review from Ivasyuk November 12, 2023 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants