Skip to content

docs: update contributing documentation#2789

Merged
georglauterbach merged 2 commits intomasterfrom
doc/update-conributing
Sep 23, 2022
Merged

docs: update contributing documentation#2789
georglauterbach merged 2 commits intomasterfrom
doc/update-conributing

Conversation

@georglauterbach
Copy link
Copy Markdown
Member

@georglauterbach georglauterbach commented Sep 21, 2022

Description

This PR updates the contribution documentation. It adds the information to add your changes to the changelog yourself (see the v11.2.0 release PR #2790). Moreover, it refactors the tests, documentation and coding style pages. These were bloated or outdated, and have been merged into one site. This seems to be the clean solution to me.

Type of change

  • This change is a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • 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 (README.md or the documentation under docs/)
  • If necessary I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

This PR updates the contribution documentation. It adds the information
to add your changes to the changelog yourself (see the v11.2.0 release
PR (which may be coming up in the future, depending on when you read
this)). Moreover, it refactores teh tests, documentation and coding
style pages. These were bloated or outdated, and have been merged into
one site. This seems to be the clean solution to me.
@georglauterbach georglauterbach added kind/improvement Improve an existing feature, configuration file or the documentation area/documentation labels Sep 21, 2022
@georglauterbach georglauterbach added this to the v11.2.0 milestone Sep 21, 2022
@georglauterbach georglauterbach self-assigned this Sep 21, 2022
@georglauterbach georglauterbach mentioned this pull request Sep 21, 2022
11 tasks
@github-actions
Copy link
Copy Markdown
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: 15b7d44

@georglauterbach georglauterbach merged commit fe2197f into master Sep 23, 2022
@georglauterbach georglauterbach deleted the doc/update-conributing branch September 23, 2022 06:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation kind/improvement Improve an existing feature, configuration file or the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants