Skip to content

Add a pull request template#278

Merged
s3lph merged 1 commit intomasterfrom
add-pull-request-template
Apr 2, 2025
Merged

Add a pull request template#278
s3lph merged 1 commit intomasterfrom
add-pull-request-template

Conversation

@rnestler
Copy link
Copy Markdown
Member

No description provided.

@rnestler rnestler requested a review from a team February 22, 2025 12:46
@rnestler rnestler force-pushed the add-pull-request-template branch from 9ff95fe to 150dcb7 Compare February 22, 2025 16:57
@@ -0,0 +1,3 @@
If you're adding a new endpoint consider the following
* [ ] Note that the list is sorted alphabetically
* [ ] Verify that your endpoint is valid using <https://validator.spaceapi.io/ui>
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think a lot of people don't know about the validator and this is a good moment to make them aware of it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Generally a good idea, but if we want to do this as a checklist, I'd formulate it as "This is completed", e.g. The endpoint is valid according to <https://validator.spaceapi.io/ui>, The new entry is at the correct (alphabetically sorted) line.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@rnestler is this something we can look it soon? We've had multiple directory PRs since, and in (close to) all of them we had to refer people to the validator.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed it. I'd encourage you to use the "Add a suggestion" feature if you want to change small wording things, such that one can just apply the change and then merge it.

@@ -0,0 +1,3 @@
If you're adding a new endpoint consider the following
* [ ] Note that the list is sorted alphabetically
* [ ] Verify that your endpoint is valid using <https://validator.spaceapi.io/ui>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Generally a good idea, but if we want to do this as a checklist, I'd formulate it as "This is completed", e.g. The endpoint is valid according to <https://validator.spaceapi.io/ui>, The new entry is at the correct (alphabetically sorted) line.

@rnestler rnestler force-pushed the add-pull-request-template branch from 150dcb7 to e6ff4c9 Compare April 2, 2025 08:39
@rnestler rnestler requested a review from s3lph April 2, 2025 08:39
Copy link
Copy Markdown
Member

@s3lph s3lph left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@s3lph s3lph merged commit fdeecda into master Apr 2, 2025
1 of 2 checks passed
@s3lph s3lph deleted the add-pull-request-template branch April 2, 2025 20:22
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.

2 participants