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

Updating README.md and CONTRIBUTING.md #133

Merged
merged 16 commits into from
Jun 27, 2024
Merged

Updating README.md and CONTRIBUTING.md #133

merged 16 commits into from
Jun 27, 2024

Conversation

samriddhi99
Copy link
Contributor

@samriddhi99 samriddhi99 commented Jun 21, 2024 •
edited
Loading

Addressed issue #132

For the Readme:

  • Add example outputs
  • Update the usage
  • Add social media links and community Slack link
  • Improve features section
  • Update with the what, why, and hows
  • Show how tirith can be implemented on CI/CD
  • Add the link to the workshop

For CONTRIBUTING.md:

  • Specifications for a new PR
  • Specifications for a new issue
  • More general rules and advice (like mention if you are taking up an issue etc)

Akshat0694
Akshat0694 previously approved these changes Jun 24, 2024
View reviewed changes
@samriddhi99 samriddhi99 changed the title Updating readme Updating README.md and CONTRIBUTING.md Jun 24, 2024
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@Akshat0694 Akshat0694 marked this pull request as ready for review June 27, 2024 12:49
refeed
refeed approved these changes Jun 27, 2024
View reviewed changes
Copy link
Member

@refeed refeed left a comment

Choose a reason for hiding this comment

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

LGTM

@Akshat0694 Akshat0694 merged commit 3b6dfa1 into main Jun 27, 2024
8 of 9 checks passed
@Akshat0694 Akshat0694 deleted the updating_readme branch June 27, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Akshat0694 Akshat0694 Akshat0694 approved these changes

@refeed refeed refeed approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@samriddhi99 @Akshat0694 @refeed