Browse Source

Updating github templates (#238)

* Support wagtail-modeltranslation (#236)

* Compatibility with wagtail_modeltranslation

* Adding How-Tos / Translation section in docs

* Editing documentation

* Updating release notes

* Updating github templates

* Adding merge process to contributing guide
Vince Salvino 5 years ago
parent
commit
80ae52fdff

+ 10 - 10
.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,24 +1,24 @@
 ---
-name: Bug report
-about: Create a report to help us improve
-title: "[BUG]"
-labels: bug
-assignees: ''
+name: Bug Report
+about: Report something that is broken, defective, or does not function correctly.
+title: ""
+labels: "Type: Bug"
+assignees: ""
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+#### Describe the bug
+A clear and concise description of what is broken.
 
-**To Reproduce**
+#### Steps to reproduce
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
+#### Expected behavior
 A clear and concise description of what you expected to happen.
 
-**Additional context**
+#### Additional context
 Add any other context about the problem here.

+ 3 - 4
.github/ISSUE_TEMPLATE/community.md

@@ -1,9 +1,8 @@
 ---
 name: Community
 about: Questions, feedback, or any other sort of inquiry.
-title: "[Community]"
-labels: community
-assignees: ''
+title: ""
+labels: "Type: Question"
+assignees: ""
 
 ---
-

+ 9 - 9
.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,20 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
-title: "[FEATURE]"
-labels: enhancement
-assignees: ''
+name: Feature Request
+about: Suggest an idea or enhancement.
+title: ""
+labels: "Type: Enhancement"
+assignees: ""
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
+#### Is your feature request related to a problem? Please describe.
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
-**Describe the solution you'd like**
+#### Describe the solution you'd like
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
+#### Describe alternatives you've considered
 A clear and concise description of any alternative solutions or features you've considered.
 
-**Additional context**
+#### Additional context
 Add any other context or screenshots about the feature request here.

+ 15 - 0
.github/pull_request_template.md

@@ -0,0 +1,15 @@
+Thank you for contributing! Please follow the guidelines below to submit your
+pull request. Additional details are available in our
+[Contributor Guide](https://docs.coderedcorp.com/cms/stable/contributing/index.html).
+
+#### Description of change
+Explain what you changed, and how or why it works the way it does.
+
+#### Documentation
+Should be added to the `docs/` directory. If you're not sure how to add
+documentation, please provide a description here instead.
+
+#### Tests
+Unit tests should be included to test your changes. If you're not sure how to
+write unit tests, please provide a description of how to test this change
+manually.

+ 34 - 0
docs/contributing/index.rst

@@ -202,12 +202,46 @@ include the following:
 * Reference to an issue if the change is related to one of the issues on our
   GitHub page.
 * Documentation updates in the ``docs/`` directory describing your change.
+* Unit tests, or a description of how the change was manually tested.
 
 Following submission of your pull request, a CodeRed member will review and test
 your change. **All changes, even by CodeRed members, must go through a pull
 request process to ensure quality.**
 
 
+Merging Pull Requests
+---------------------
+
+Follow these guidelines to merge a pull request into the master branch:
+
+* Unit tests pass.
+* Code coverage is not lower than master branch.
+* Documentation builds, and the PR provides documentation (release notes at a
+  minimum).
+* If there is a related issue, the issue is referenced and/or closed (if
+  applicable)
+* Finally, always make a squash merge with a single descriptive commit message.
+  Avoid simply using the default commit message generated by GitHub if it is a
+  summary of previous commits or is not descriptive of the change.
+
+In the event that the pull request needs more work that the author is unable to
+provide, the following process should be followed:
+
+* Create a new branch from master in the form of ``merge/pr-123`` where 123 is
+  the original pull request number.
+* Edit the pull request to merge into the new branch instead of master.
+* Make the necessary changes and submit for review using the normal process.
+* When merging this branch into master, follow the same process above, but be
+  sure to credit the original author(s) by adding their names to the bottom of
+  the commit message as so (see
+  `GitHub documentation <https://help.github.com/en/articles/creating-a-commit-with-multiple-authors>`_):
+
+  .. code-block:: text
+
+      Co-authored-by: name <name@example.com>
+      Co-authored-by: another-name <another-name@example.com>
+
+
 Building Python Packages
 ------------------------