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

Update readme.md and further links in rm project material #42

Conversation

tanjadegroot
Copy link
Collaborator

What type of PR is this?

Add one of the following kinds:

  • cleanup
  • documentation

What this PR does / why we need it:

  • Corrects links in README.md and in other RM documentation files.
  • Moves CHANGELOG_TEMPLATE.md to SupportingDocuments folder

Which issue(s) this PR fixes:

Fixes #40

Special notes for reviewers:

Changelog input

 release-note

Additional documentation

This section can be blank.

docs

update links and content
…Documents/CHANGELOG_EXAMPLE.md

moved CHANGELOG EXAMPLE to Supporting Documents
added a release number r1.0.0 in the scope. Release tag is to be done
Corrected link to wiki
update links and did a few minor tweaks
Copy link
Collaborator

@hdamker hdamker left a comment

Choose a reason for hiding this comment

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

My comments are all on the links: my recommendation would be to use relative links if pointing to the same repository.

Regarding the release number: really 1.0.0 aside of Commonalities with 0.4.0 and ICM with 0.2.0? Let's discuss within the RM call.

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 Outdated Show resolved Hide resolved
documentation/API_Release_Guidelines.md Outdated Show resolved Hide resolved
documentation/API_Release_Guidelines.md Outdated Show resolved Hide resolved
documentation/API_Release_Guidelines.md Outdated Show resolved Hide resolved
tanjadegroot and others added 8 commits July 22, 2024 18:21
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
Co-authored-by: Herbert Damker <herbert.damker@telekom.de>
@tanjadegroot
Copy link
Collaborator Author

Thanks Herbert ! local links are much better indeed.
Let's close and merge this on the RM call tomorrow.

@hdamker hdamker merged commit 5eaa484 into camaraproject:main Jul 23, 2024
@tanjadegroot tanjadegroot deleted the Update-readme.md-and-further-links-in-RM-project-material branch July 26, 2024 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update links in README.md file
2 participants