Skip to content

WIP: Feature/contributing file#12

Open
luca-c-xcv wants to merge 9 commits intoTheG-r-itters:developfrom
luca-c-xcv:feature/contributing-file
Open

WIP: Feature/contributing file#12
luca-c-xcv wants to merge 9 commits intoTheG-r-itters:developfrom
luca-c-xcv:feature/contributing-file

Conversation

@luca-c-xcv
Copy link
Member

Describe your changes

Issue ticket number and link

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.
  • CHANGELOG.md has been updated should there be relevant changes in this PR.

Created the contribution file to be used to explain the guidelines for
completing a proper 'pull request'.
Inside is a comment with a link to a github help page useful for
understanding how to build the file.
created filesystem structure with README files inside the directories to keep
the strucutre consistent
the python cache directories and the log files added to the new
gitignore file
added a docker folder where to put all the docker files (Dockerfile and
docker-compose) to create images for all the necessary services.
created a draft docker compose in which a set of networks was defined for
internal and external communications and some services under development
removed the filesystem structure because it was redesigned
fixed some issue in the docker compose file and removed the
docker/logger directory and files inside
Created a contribution file to explain how to create issues and how to create
a patch to submit to this repository.
@luca-c-xcv luca-c-xcv added the documentation Improvements or additions to documentation label Jun 2, 2024
@luca-c-xcv luca-c-xcv requested a review from feed3r June 2, 2024 21:38
Copy link
Contributor

@feed3r feed3r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor changes in spelling for the contributing guide, but a major comment about the project structure (let's include the Communications submodule)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sometimes it's spelled gitAssistant (with lower g) and sometimes, especially in titles it's spelled GitAssistant (with capital G). For sure I think it should be coherent, and my preference is for GitAssistant (with capital G)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as for the docker-services. We should include the presence of submodule Communications for the Kafka infrastructure

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.

2 participants