Frontend for the Admin Portal. This web interface is used by Community Admins (cadmins) to administer community-specific portals and by Super Admins to administer the entire MassEnergize web platform.
4
stars
3
forks
source link
feat: Update pull request template and add new markdown files #1172
This pull request introduces the CONTRIBUTION.md which provides instructions for commit messages. It also updates the PR template with a more detailed checklist to guide contributors. A CODE_OF_CONDUCT.md is also implemented to set standards for participants' behavior in the project.
Details
The commit introduces guidelines for contributing to the project, providing instructions for commit messages. This aim of this is to guide contributors in making meaningful commit messages.
The PR template has been updated with a more detailed checklist which will improve the understanding of the necessary steps when making a PR.
Additionally, a code of conduct has been introduced. This will set expectations for behavior when interacting with the project and ensure a healthy, positive environment for all contributors.
Unfortunately, screenshots or testing steps are not applicable for this kind of commit, as changes involve mostly documentation and guidelines.
Requirements
[x] I've read and understood the Contributing Guidelines and have done my best effort to follow them.
[ ] I moved the linked issue from the "Sprint backlog" to "In progress" when I started this.
[ ] I moved the linked issue to "QA Verification" now that it is ready to merge.
What kind of change does this PR introduce? (check at least one)
[ ] Bugfix
[x] Feature
[ ] Performance improvement
[ ] Feature removal
[ ] Code style update
[x] Refactor
[x] Docs
[ ] Build-related changes
Does this PR introduce a breaking change? (check one)
[ ] Yes
[x] No
If yes, please describe the impact and migration path for existing applications:
The PR changes the way commit messages should be crafted, introduces a new format for PRs and adds a code of conduct which all contributors should adhere to. Contributors need to familiarize themselves with these changes and apply them in future interactions with the project.
The PR fulfills these requirements:
[x] It's submitted to the dev branch or to a feature branch, not the main branch
[x] When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)
[x] All tests are passing
[ ] New/updated tests are included
Other information: Any other thing we need to know
No additional information.
Summary / Highlights
This pull request introduces the CONTRIBUTION.md which provides instructions for commit messages. It also updates the PR template with a more detailed checklist to guide contributors. A CODE_OF_CONDUCT.md is also implemented to set standards for participants' behavior in the project.
Details
The commit introduces guidelines for contributing to the project, providing instructions for commit messages. This aim of this is to guide contributors in making meaningful commit messages.
The PR template has been updated with a more detailed checklist which will improve the understanding of the necessary steps when making a PR.
Additionally, a code of conduct has been introduced. This will set expectations for behavior when interacting with the project and ensure a healthy, positive environment for all contributors.
Unfortunately, screenshots or testing steps are not applicable for this kind of commit, as changes involve mostly documentation and guidelines.
Requirements
[x] I've read and understood the Contributing Guidelines and have done my best effort to follow them.
[x] I've tested my changes manually.
[ ] I've added unit tests to my PR.
Transparency (Project board)
[x] I've given my PR a meaningful title.
[ ] I linked this PR to the relevant issue.
[ ] I moved the linked issue from the "Sprint backlog" to "In progress" when I started this.
[ ] I moved the linked issue to "QA Verification" now that it is ready to merge. What kind of change does this PR introduce? (check at least one)
[ ] Bugfix
[x] Feature
[ ] Performance improvement
[ ] Feature removal
[ ] Code style update
[x] Refactor
[x] Docs
[ ] Build-related changes
Does this PR introduce a breaking change? (check one)
The PR fulfills these requirements:
dev
branch or to a feature branch, not themain
branchfix #xxx[,#xxx]
, where "xxx" is the issue number)