Added pull request and issue templates to repo

This commit is contained in:
Mike Molinari 2022-08-27 05:52:35 +00:00 committed by Val Erastov
parent 5ee42b9068
commit 9e9b152c23
4 changed files with 60 additions and 0 deletions

8
.github/CONTRIBUTING.md vendored Normal file
View file

@ -0,0 +1,8 @@
First off. You are awesome. Thanks for wanting to help contribute to the JSketcher project.
To make things easier to manage we have some guidelines that will help to keep the codebase clean and tidy.
1. No merge commits. Everything should be rebased on top of the main branch. History should be one line/linear
2. No unnecessary formatting/prettifiyng. Only for the neighborhood of the actual change.
3. Indent is always 2 spaces.
4. Execute ```npm run before-main-branch-merge``` to statically check and lint the code.

30
.github/ISSUE_TEMPLATE vendored Normal file
View file

@ -0,0 +1,30 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
assignees: ["mmiscool", "xibyte"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
id: jsketcherJSON
attributes:
label: Exported JSKetcher part file JSON
description: Please copy and paste the text of the exported JSKetcher project
render: shell

16
.github/pull_request_template.md vendored Normal file
View file

@ -0,0 +1,16 @@
Related issue: #XXXX (if applicable)
=========================
Description:
=========================
A clear and concise description of what the problem was and how this pull request solves it.
If pull request is for a new feature a clear description of the feature and usage.
Contributor name: XXXXX
=========================
Confirm compliance with JSketcher project license.
=========================
- [x] Pull request is made compliance with JSKetcher license

View file

@ -81,3 +81,9 @@ Install node.js
* $ cd \<jsketcher folder\>
* $ npm install
* $ npm start
Contributing Please see [.github/CONTRIBUTING.md ](.github/CONTRIBUTING.md )
=========================