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

[Doc] improve ReadMe and Contributing (Debugging- and Snapshot-section) #175

Merged
merged 2 commits into from Jul 5, 2021

Conversation

@HannesWell
Copy link
Contributor

@HannesWell HannesWell commented Jul 3, 2021

With this PR I suggest improvements for Tycho's documentation.
This includes the following changes:

  • In README.md

    • fix the formatting of the doc list, on Github the listing was not rendered correctly.
    • add an item to the release notes
    • mention the snapshots as well
  • In CONTRIBUTING

    • extend the snapshot section, inspired by the Release-Notes sections from Tycho's Eclipse wiki so one can simply copy and paste the relevant snippets.
    • extend the build section to distinguish between builds for 'testing' if everything works and builds to install Tycho locally to test changes with a project-build.
    • Change the suggested way to debug Tycho to the (in my opinion) more convenient way of launching Maven from Eclipse in Debug-mode. Do you think the previous way should remain as an alternative?

Please don't hesitate to let me know, if you don't find any of those changes useful.

CONTRIBUTING.md Show resolved Hide resolved
Change-Id: Id669c0c96bdcfa700a0bb890189504b5dc62f7dc
Signed-off-by: Hannes Wellmann <wellmann.hannes1@gmx.net>
@mickaelistria mickaelistria merged commit b9e57ff into eclipse:master Jul 5, 2021
1 check passed
@HannesWell HannesWell deleted the doc branch Jul 5, 2021
@laeubi laeubi added this to the 2.5 milestone Sep 21, 2021
@laeubi laeubi removed this from the 2.5 milestone Sep 21, 2021
@laeubi laeubi added this to the 2.4 milestone Sep 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants