Replies: 3 comments
-
I agree that this will be useful. Our main requirement for PRs (currently) is that the PR author should provide a writeup explaining the purpose of the PR. As this writeup will be used as the commit message when the PR is merged, it should follow these guidelines for commit messages. This requirement could be stated in the PR template. |
Beta Was this translation helpful? Give feedback.
-
Yes, this could be useful. 👍 |
Beta Was this translation helpful? Give feedback.
-
@anubh-v @damithc thank you for the feedback, especially Anubhav And with this, subsequently train us as developers as well to write I will raise an issue for this then for anyone to pick this task up! 👍 |
Beta Was this translation helpful? Give feedback.
-
Summary
To assist newer contributors (now and in the future), I think it would be a good idea to introduce PR templates such that
contributors are able to better describe what their Pull Requests does. And also help the reviewers understand the changes
made and the changes in specific services / components to be aware of.
Description
Currently, quite a few of the PRs not only in CATcher, but other NUS-OSS Repositories do not really have a standardized way of
documenting their Pull Requests. Even if there was such a standard, it was not enforced. We can start off in CATcher and possibly
expand it to other NUS-OSS projects.
What do you all think? @CATcher-org/2021-devs
Beta Was this translation helpful? Give feedback.
All reactions