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.

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

Readme: Add 5Ws about faebryk #93

Merged

Conversation

ruben-iteng
Copy link
Collaborator

Readme: Add 5Ws about faebryk

Description

Add 5Ws (what, how, who, why, when, where) about faebryk
Fix markdown code blocks

Checklist

Please read and execute the following:

  • My code follows the coding guidelines of this project
  • My PR title is following the contribution guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I ran Black to format my code

Code of Conduct

By submitting this issue, you agree to follow our Code of Conduct:

Add 5Ws (what, how, who, why, when, where) about faebryk
Fix markdown code blocks
@ruben-iteng ruben-iteng added 📄 area: documentation Improvements or additions to documentation ✨ goal: improvement Improvement to an existing feature 🟨 priority: medium Not blocking but should be fixed soon labels Jun 24, 2022
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@NoR8quoh1r NoR8quoh1r left a comment

Choose a reason for hiding this comment

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

Thanks you for doing this ❤️ , expanding the readme in this way adds a lot of value for people checking out faebryk.

I have some comments, consider them suggestions.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Fix releases shield link
Add links to various places
Add development and versioning sections
Copy link
Contributor

@IoannisP-ITENG IoannisP-ITENG left a comment

Choose a reason for hiding this comment

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

Looks good!

@IoannisP-ITENG IoannisP-ITENG merged commit 54ff2b7 into faebryk:main Jun 24, 2022
@ruben-iteng ruben-iteng deleted the feature/add_5_ws_about_faebryk branch June 24, 2022 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 area: documentation Improvements or additions to documentation ✨ goal: improvement Improvement to an existing feature 🟨 priority: medium Not blocking but should be fixed soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants