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

DM-48013: Add contribution guide and pull request template #290

Closed
wants to merge 2 commits into from

Conversation

andy-slac
Copy link
Contributor

No description provided.

@@ -0,0 +1,3 @@
## Checklist

- [ ] If changing `apdb.yaml`, it usually requires version number increment, check [schema versioning page](https://rubinobs.atlassian.net/wiki/external/OGUyOGM1OTY0MTRkNGFmNThkNWM4N2U1NGFmODJkNWY) for details.
Copy link
Member

Choose a reason for hiding this comment

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

I think @ebellm said that changes to apdb.yaml also need to be synchronized with https://github.com/lsst/alert_packet?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We can certainly mention that too, please suggest wording for it.

Copy link
Collaborator

@JeremyMcCormick JeremyMcCormick Dec 9, 2024

Choose a reason for hiding this comment

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

I think @ebellm said that changes to apdb.yaml also need to be synchronized with https://github.com/lsst/alert_packet?

I see that there are detailed instructions on synchronizing alert_packet with sdm_schemas under Adding a New Schema.

We can provide a direct link to this section in the sdm_schemas docs which cover the APDB.

Copy link
Collaborator

@JeremyMcCormick JeremyMcCormick left a comment

Choose a reason for hiding this comment

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

I'm going to put a review hold on this for the time being so it doesn't get inadvertently merged. I discussed with Andy today about making a more generic checklist and contribution guide and will take over development on this branch.

I have no problem if we eventually create a dedicated page for APDB considerations within sdm_schemas itself, too, e.g., incorporating information like that mentioned in #290 (comment). That could be on a separate branch/ticket from the more generic contribution guide and checklist.

I don't think we should link to Confluence pages. I would prefer if it was self-contained and the checklist pointed to pages within the sdm_schemas repository, only.

@JeremyMcCormick
Copy link
Collaborator

I'm going to re-open a new PR so Andy can be a reviewer.

@JeremyMcCormick JeremyMcCormick changed the title DM-48013: Add PR checklist mentioning APDB versioning DM-48013: Add contribution guide and pull request template Dec 9, 2024
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.

3 participants