diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..ce91397b --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE new file mode 100644 index 00000000..8e5d25b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE @@ -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 \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..ce357006 --- /dev/null +++ b/.github/pull_request_template.md @@ -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 \ No newline at end of file diff --git a/README.md b/README.md index e1ca28c1..b0ac0891 100644 --- a/README.md +++ b/README.md @@ -81,3 +81,9 @@ Install node.js * $ cd \ * $ npm install * $ npm start + + + + +Contributing Please see [.github/CONTRIBUTING.md ](.github/CONTRIBUTING.md ) +=========================