Skip to content

Commit

Permalink
Changed the issue and pull request templates templates [#605]
Browse files Browse the repository at this point in the history
 * Updated the PR template.
 * Updated CONTRIBUTING.md to call out single commits.
 * Added a security issue template.
  • Loading branch information
mcpierce committed Feb 27, 2021
1 parent 6635245 commit b617ba9
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 61 deletions.
28 changes: 14 additions & 14 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -1,25 +1,25 @@
---
name: Bug report
about: Create a report to help us improve
title: 'Describe the bug using a single sentence'
about: Create a report to help us improve ComiXed
title: '[BUG] Describe the bug using a single sentence'
labels: 'bug'
assignees: ''

---

**NOTE: If this involves a pre-releae version of ComiXed and not a release, then please send an email to the mailing list rather than creating an issue here.**
**NOTE: If this involves a pre-release version of ComiXed and not a release, then please send an email to the mailing list rather than creating an issue here. All such bug reports will be closed.**

**Describe the bug**
A clear and concise description of what the bug is.
**Describe The Bug**
A clear and concise description of what the bug is. Please include as much detail as possible.

**To Reproduce**
Steps to reproduce the behavior:
**To Reproduce The Bug**
Steps to reproduce the behavior. Please be as complete as possible and describe the exact steps and values used to cause the error:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
1. Click on '....'
1. Scroll down to '....'
1. See error

**Expected behavior**
**Expected Behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
Expand All @@ -31,8 +31,8 @@ If applicable, add screenshots to help explain your problem.
- Browser name [e.g. chrome, safari]
- Browser version [e.g. 22]

** ComiXed Build Detail **
Copy and past the details from **Help** -> **Build Details**
**ComiXed Build Detail:**
Copy and past the details from **Build Details** menu option.

**Additional context**
**Additional Context**
Add any other context about the problem here.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -1,8 +1,8 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
title: '[REQUEST] Enter a description'
labels: 'feature'
assignees: ''

---
Expand Down
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/security_issue.md
@@ -0,0 +1,16 @@
---
name: Security issue
about: Create a report to help us improve
title: '[CVE-####-#####] Describe the security using a single sentence'
labels: 'security'
assignees: ''

---

**NOTE: If this involves a pre-release version of ComiXed and not a release, then please send an email to the mailing list rather than creating an issue here. All such bug reports will be closed.**

**Describe The Security Issue**
A clear and concise description of what the issue is. Please include any links to the vulnerability and any affected dependencies.

**Additional Context**
Add any other context about the problem here.
26 changes: 17 additions & 9 deletions CONTRIBUTING.md
Expand Up @@ -5,6 +5,11 @@ email, or any other method with the owners of this repository before making a ch

Please note we have a code of conduct, please follow it in all your interactions with the project.

## Use A Single Commit For Each Feature Or Bug Fix

To make searching history easier, we ask that you bundle your changes into a single commit, and that commit should
address a single feature or issue.

## Commit Message Rules

The goal of the following rules is to make the output for the follow command line easier to read:
Expand All @@ -28,15 +33,17 @@ easier, and will help to make your contributions easier to understand.
Source: http://chris.beams.io/posts/git-commit/#seven-rules

### Do
* Write the summary line and description of what you have done in the imperative mood, that is as if you were narrating the changes. Start the line with "Fixed", "Added", "Changed" instead of "Fixes", "Adds", "Changes".
* Write the summary line and description of what you have done in the imperative mood, that is as if you were narrating
the changes. Start the line with "Fixed", "Added", "Changed" instead of "Fixes", "Adds", "Changes".
* Always leave the second line blank.
* Line break the commit message (to make the commit message readable without having to scroll horizontally in gitk).

### Do Not
* Don't end the summary line with a period - it's a title and titles don't end with a period.

### Tips
* If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using git add -p.
* If it seems difficult to summarize what your commit does, it may be because it includes more than one feature or bug
fix. If that is the case, please consider breaking them up into multiple commits and open a separate issue for each.

## Commit Template

Expand Down Expand Up @@ -97,7 +104,7 @@ Most editors and IDEs support formatting Typescript code. Please check the docum
To ensure your Angular code meets project requirements, please run the lint checks in the **comixed-frontend** module:

```
$ cd comixed-frontend
$ cd comixed-web
$ yarn lint
```

Expand All @@ -120,14 +127,14 @@ Once you've installed the requirements, you need to setup your environment:

The application is composed of several modules:
* **comixed-model**: the domain model
* **comixed-repositories**: the repositories,
* **comixed-repositories**: the database repository interfaces,
* **comixed-adaptors**: the various adaptors for loading archives, images, etc.,
* **comixed-services**: the business logic layer,
* **comixed-scrapers**: the library for building comic data scrapers,
* **comixed-tasks**: the set of worker tasks that run in the backend server
* **comixed-rest-api**: the web layer and REST API processors,
* **comixed-frontend**: the Angular frontend, and
* **comixed-app**: the application, which pulls the previous pieces together in a working application.
* **comixed-tasks**: the set of worker tasks that run on the server,
* **comixed-rest-api**: the REST API processors,
* **comixed-web**: the Angular frontend, and
* **comixed-app**: the core module, which pulls the previous pieces together in a working application.

To build all of them then execute the following from the project's root directory:

Expand Down Expand Up @@ -190,7 +197,8 @@ as your make changes to the Angular code, this frontend will update automaticall
## Unit Tests

To help keep the code as thoroughly tested and understandable as possible, all features and bug fixes must come with some
set of unit tests to demonstrate and validate them. Contributions should never reduce the unit test coverage for the project.
set of unit tests to demonstrate and validate them. Contributions should never reduce the unit test coverage for the
project.

Please also be sure that the contribution does not break any existing unit tests. So be sure to run the full suite of unit
tests for the entire project before submitting your pull request.
Expand Down
57 changes: 21 additions & 36 deletions PULL_REQUEST_TEMPLATE.md
@@ -1,42 +1,27 @@
## Status
**READY/IN DEVELOPMENT/HOLD**

## Migrations
YES | NO

## Description
A few sentences describing the overall goals of the pull request's commits.

## Related PRs
List related PRs against other branches:

branch | PR
------ | ------
other_pr_production | [link]()
other_pr_master | [link]()
## Changes Need To Be Discussed First

Before opening a pull request, please be sure to announce your changes in [the
developer mailing list](https://www.freelists.org/list/comixed-dev) (and subscribe if you
haven't already). This will help speed up getting your pull request reviewed and merged.

## Todos
- [ ] Tests
- [ ] Documentation
**NOTE:** You can erase any parts of this template that are not applicable to your PR,
including this top section.

## Status
READY/IN DEVELOPMENT/HOLD

## Deploy Notes
Notes regarding deployment the contained body of work. These should note any
db migrations, etc.

## Steps to Test or Reproduce
Outline the steps to test or reproduce the PR here.

```sh
git pull --prune
git checkout <feature_branch>
bundle; script/server
```

1.
## Does this PR contain migrations?
YES | NO

## Impacted Areas in Application
List general components of the application that this PR will affect:
## Before You Submit Your PR:
- [ ] Have you announced your PR on the comixed-dev mailing list?
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

*

0 comments on commit b617ba9

Please sign in to comment.