Commits Made Direct to Main

Oct 13, 2025 by recoveryshake.com 35 views

Introduction

In light of recent updates, we require the following of all updates to the main branch of any Metanorma ticket to be reflected in the PR template. This article outlines the necessary modifications to the existing PR template to ensure that all updates are properly tracked and documented.

Background

The tickets that updates to Metanorma have come from need to be recovered, in order to construct the fortnightly change log. The assumed way of operating until now has been to include a link to the ticket in the commit message. However, with the recent institution of releases in the Metanorma project, we require a more structured approach to tracking updates.

New Requirements

To ensure that all updates are properly tracked and documented, we require the following:

Assign the PR to the Metanorma project
Assign the PR to the next scheduled release, if it is merged to main
Have the PR description link back to the issue it comes from

If a PR fails to do these things, it is not valid for Metanorma purposes, as its provenance cannot be tracked.

Commits Made Direct to Main

Commits made direct to main are not recommended, and if they happen, they must link back to the relevant issue.

Documentation Updates

In addition, any change that will alter user interaction with Metanorma must be documented on metanorma.org, with a PR made to that repository. This is already a checkbox item on the template. If there is no obvious place to put that documentation, a page must be created to put it as part of the PR.

Modified PR Template

Accordingly, the existing PR template should be modified as follows:

Metanorma PR checklist

[]  **Breaking changes** (list related PRs)
[]  **Documentation update required** ()
[]  **External dependency introduced** ([documentation update need](https://github.com/metanorma/metanorma.org/issues/new))
[]  **Gem with native library introduced**
[]  **Assign PR to Metanorma project**
[]  **Assign PR to current release on Metanorma project if merging to main**
[]  **Link PR description back to issue it comes from**

Fixes:

*   _Remember to assign PR to Metanorma project, and to current release on Metanorma project if merging to main_
*   _Link PR description back to issue it comes from_
*   _Document any changes that will alter user interaction with Metanorma on metanorma.org, with a PR made to that repository_

Key Changes

The modified PR template includes the following key changes:

Assign PR to Metanorma project: This ensures that all updates are properly tracked and documented.
Assign PR to current release on Metanorma project if merging to main: This ensures that all updates are properly released and documented.
Link PR description back to issue it comes from: This ensures that all updates are properly linked back to the original issue.
Document any changes that will alter user interaction with Metanorma on metanorma.org, with a PR made to that repository: This ensures that all changes that will alter user interaction with Metanorma are properly documented.

Conclusion

Introduction

The modified PR template outlined in the previous article ensures that all updates to the main branch of any Metanorma ticket are properly tracked and documented. However, we understand that you may have questions about the new requirements and how to implement them. In this article, we will answer some of the most frequently asked questions about the Metanorma PR template.

Q: What is the purpose of the Metanorma PR template?

A: The purpose of the Metanorma PR template is to ensure that all updates to the main branch of any Metanorma ticket are properly tracked and documented. This includes assigning the PR to the Metanorma project, assigning the PR to the next scheduled release, and linking the PR description back to the issue it comes from.

Q: Why is it necessary to assign the PR to the Metanorma project?

A: Assigning the PR to the Metanorma project ensures that all updates are properly tracked and documented. This allows us to keep a record of all changes made to the project and ensures that all updates are properly released.

Q: What is the purpose of assigning the PR to the next scheduled release?

A: Assigning the PR to the next scheduled release ensures that all updates are properly released and documented. This allows us to keep a record of all changes made to the project and ensures that all updates are properly tracked.

Q: Why is it necessary to link the PR description back to the issue it comes from?

A: Linking the PR description back to the issue it comes from ensures that all updates are properly linked back to the original issue. This allows us to keep a record of all changes made to the project and ensures that all updates are properly tracked.

Q: What happens if I fail to follow the new requirements?

A: If you fail to follow the new requirements, your PR will not be valid for Metanorma purposes. This means that your update will not be properly tracked and documented, and you will not be able to release your update.

Q: How do I document any changes that will alter user interaction with Metanorma?

A: To document any changes that will alter user interaction with Metanorma, you must create a PR to the metanorma.org repository. This will ensure that all changes are properly documented and released.

Q: What if there is no obvious place to put the documentation?

A: If there is no obvious place to put the documentation, you must create a new page to put it as part of the PR. This will ensure that all changes are properly documented and released.

Q: Can I make commits directly to the main branch?

A: No, you should not make commits directly to the main branch. Instead, you should create a PR to the main branch and follow the new requirements outlined in the modified PR template.

Q: What if I make a commit directly to the main branch?

A: If you make a commit directly to the main branch, you must link the commit back to the relevant issue. This will ensure that all updates are properly tracked and documented.

Conclusion

In conclusion, the Metanorma PR template is designed to ensure that all updates to the main branch of any Metanorma ticket are properly tracked and documented. By following the new requirements outlined in the modified PR template, you can ensure that all updates are properly released and documented. If you have any further questions, please don't hesitate to contact us.