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

Decompose the README & add a contributing guide #1650

Merged
merged 6 commits into from Dec 7, 2022

Conversation

Gedochao
Copy link
Contributor

@Gedochao Gedochao commented Dec 7, 2022

  • extracted the dev docs to a separate document
  • updated the README header
  • linked all (?) side-README docs in the main README, as it was easy to miss some of them
  • fixed the formatting here and there
  • added a contributing guide
  • added some extra explanations on how to filter unit test suites
  • updated some other deprecated points (IDE imports now work out of the box, Node 16+ is necessary for the website, etc)

Extra thanks to @alexarchambault, who has written the early draft for the contribution guidelines some time ago.

DEV.md Outdated Show resolved Hide resolved
DEV.md Show resolved Hide resolved
DEV.md Outdated Show resolved Hide resolved
DEV.md Show resolved Hide resolved
Copy link
Contributor

@lwronski lwronski left a comment

Choose a reason for hiding this comment

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

LGTM

@tgodzik tgodzik merged commit 6d34348 into VirtusLab:main Dec 7, 2022
@Gedochao Gedochao deleted the tweak-readme branch December 8, 2022 10:09
@Gedochao Gedochao added the documentation Improvements or additions to documentation label Dec 8, 2022
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.

None yet

3 participants