Skip to content

[skip changelog] Consolidate integration test instructions #972

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

Merged
merged 1 commit into from
Oct 5, 2020
Merged

[skip changelog] Consolidate integration test instructions #972

merged 1 commit into from
Oct 5, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Sep 23, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Docs update

  • What is the current behavior?

Instructions for running integration tests are present both in CONTRIBUTING.md as well as
in test/README.md.

Although most of the content was duplicated, there was
some important unique content on each page and the readers of one document would not necessarily know
of the existence of relevant information in the other.

Duplicate content is more work to maintain, and likely to end up becoming outdated.

  • What is the new behavior?

Unique content from test/README.md is merged into CONTRIBUTING.md and replaced with a
link to that content.

  • Does this PR introduce a breaking change?

No

Previously, instructions for running integration tests were present both in CONTRIBUTING.md as well as
in test/README.md.

Although most of the content was duplicated, there was
some important unique content on each page and the readers of one document would not necessarily know
of the existence of relevant information in the other.

Duplicate content is more work to maintain, and likely to end up becoming outdated.

So I have transfered the unique content from test/README.md to CONTRIBUTING.md and replaced it with a
link to that content.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Sep 23, 2020
@per1234 per1234 merged commit 143a4db into arduino:master Oct 5, 2020
@per1234 per1234 deleted the consolidate-integration-testing-docs branch October 5, 2020 17:40
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants