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

[Issue#3] create README.md with info on: how-to work with repository #4

Merged
merged 2 commits into from
Oct 22, 2023
Merged

[Issue#3] create README.md with info on: how-to work with repository #4

merged 2 commits into from
Oct 22, 2023

Conversation

bugITwhisperer
Copy link
Collaborator

Partially Resolves #3

Scope of changes

  • create README.md file,
  • how-to work with repository: installation prerequisites; installation steps; how to run tests

@bugITwhisperer bugITwhisperer mentioned this pull request Oct 22, 2023
Closed
16 tasks
@bugITwhisperer bugITwhisperer changed the title [Issue#3] [chore(docs)] create basic README.md [Issue#3] [chore(docs)] create README.md with info on: how-to work with repository Oct 22, 2023
KarolinaZakrzewska
KarolinaZakrzewska approved these changes Oct 22, 2023
View reviewed changes
Copy link
Collaborator

@KarolinaZakrzewska KarolinaZakrzewska left a comment

Choose a reason for hiding this comment

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

The basic README file is fine, we can expand it later.

@bugITwhisperer bugITwhisperer merged commit ec647f1 into main Oct 22, 2023
@bugITwhisperer bugITwhisperer deleted the issue3_readme_init branch October 22, 2023 20:33
@bugITwhisperer bugITwhisperer changed the title [Issue#3] [chore(docs)] create README.md with info on: how-to work with repository [Issue#3] create README.md with info on: how-to work with repository Oct 23, 2023
@bugITwhisperer bugITwhisperer self-assigned this Nov 2, 2023
@bugITwhisperer bugITwhisperer added the documentation Improvements or additions to documentation label Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kat-kan kat-kan kat-kan approved these changes

@KarolinaZakrzewska KarolinaZakrzewska KarolinaZakrzewska approved these changes

Assignees

@bugITwhisperer bugITwhisperer

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Github workflow standards && project standards to be established
3 participants
@bugITwhisperer @kat-kan @KarolinaZakrzewska