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.

Sign up for GitHub

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

Jump to bottom

Reword recommendations around self links in the item spec #1173

Merged
merged 2 commits into from
Jun 13, 2022
Merged

Reword recommendations around self links in the item spec #1173

merged 2 commits into from
Jun 13, 2022

Conversation

gadomski
Copy link
Collaborator

@gadomski gadomski commented Mar 3, 2022 •
edited
Loading

Related Issue(s):

Proposed Changes:

  1. Change some language in the best practices document w.r.t. flexibility around the use of self links.
  2. Point to the best practices in the item spec instead of strongly recommending the use of self links.

PR Checklist:

  • This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
  • This PR has no breaking changes.
  • I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.

jonhealy1
jonhealy1 reviewed Mar 4, 2022
View reviewed changes
best-practices.md Outdated Show resolved Hide resolved
@gadomski
fix: reword recommendations on self links
417df5c 
There was some confusing language about when `self` links should be
used. This commit fixes the language in the "Use of links" section of
the best practices document, and updates the wording in the item spec
to reference the best practices section.
@gadomski
chore: update changelog
07d42ea
@jonhealy1 jonhealy1 mentioned this pull request Mar 8, 2022
Merged
5 tasks
@matthewhanson matthewhanson merged commit ff4996d into radiantearth:dev Jun 13, 2022
@gadomski gadomski deleted the self-link-recommendations branch June 13, 2022 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonhealy1 jonhealy1 jonhealy1 approved these changes

@matthewhanson matthewhanson matthewhanson approved these changes

@cholmes cholmes cholmes approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@gadomski @cholmes @matthewhanson @jonhealy1