GitHub template update (#203)
* Initial commit * Create CODE_OF_CONDUCT.md * Create CONTRIBUTING.MD * Update CODE_OF_CONDUCT.md adds authoritative source notice to this repo * Create ISSUE_TEMPLATE.md * Update CODE_OF_CONDUCT.md * Update and rename CONTRIBUTING.MD to CONTRIBUTING.md * Update README.md adds basic default social badges - discourse and twitter * Update README.md * Update README.md * Update README.md * Update README.md * Create LICENSE * Update README.md * Update README.md * Update CONTRIBUTING.md fixes link * Update CODE_OF_CONDUCT.md * docs: add slack link and badge * Update README.md * fix: link and typos * fix: more links * refactor: moved files to .github/ folder * feat: added PR template Updated docs to reflect it. * fix: updated old link * fix: added yaml frontmatter block to issue template * docs: removes links to slack * docs: adds link to docs * Update README.md * Create open-issue.yml * Create close-issue.yml * Fixes: PR template updated to provide detailed instructions * Add link to speckle-server contribution guide * Fix link to relative to the repo pull requests * Feature: separates issue template into bugs and feature requests * Provides checklist for both issue templates * Hides instructions in comments * Add link to contribution guidelines * Retain some sections from previous issue template * checklist is clearer * style: tidy newlines and other small formatting * Add a SECURITY.md file * Refer to the code of conduct in the contributing section of the README * chore(pr_template): adds a reference section to the PR template The SpecklePY PR template had a reference section, and it made sense to include it for all repositories. * Remove redundant issue template * fix(pull request template): pR template should be the default and not an option PR template was in a directory which allows selection using queries. The PR template should be provided by default so should be renamed and placed in the .github directory. Co-authored-by: Dimitrie Stefanescu <didimitrie@gmail.com> Co-authored-by: izzy lyseggen <izzy.lyseggen@gmail.com> Co-authored-by: Matteo Cominetti <matteo@cominetti.org> Co-authored-by: Alan Rynne <alan@speckle.systems> Co-authored-by: Alan Rynne <alan@rynne.es> Co-authored-by: Matteo Cominetti <matteo@speckle.systems>
This commit is contained in:
Iain Sproat
@@ -0,0 +1,102 @@
|
||||
<!---
|
||||
|
||||
Provide a short summary in the Title above. Examples of good PR titles:
|
||||
|
||||
* "Feature: adds metrics to component"
|
||||
|
||||
* "Fix: resolves duplication in comment thread"
|
||||
|
||||
* "Update: apollo v2.34.0"
|
||||
|
||||
-->
|
||||
|
||||
## Description & motivation
|
||||
|
||||
<!---
|
||||
|
||||
Describe your changes, and why you're making them. What benefit will this have to others?
|
||||
|
||||
Is this linked to an open Github issue, a thread in Speckle community,
|
||||
or another pull request? Link it here.
|
||||
|
||||
If it is related to a Github issue, and resolves it, please link to the issue number, e.g.:
|
||||
Fixes #85, Fixes #22, Fixes username/repo#123
|
||||
Connects #123
|
||||
|
||||
-->
|
||||
|
||||
## Changes:
|
||||
|
||||
<!---
|
||||
|
||||
- Item 1
|
||||
- Item 2
|
||||
|
||||
-->
|
||||
|
||||
## To-do before merge:
|
||||
|
||||
<!---
|
||||
|
||||
(Optional -- remove this section if not needed)
|
||||
|
||||
Include any notes about things that need to happen before this PR is merged, e.g.:
|
||||
|
||||
- [ ] Change the base branch
|
||||
|
||||
- [ ] Ensure PR #56 is merged
|
||||
|
||||
-->
|
||||
|
||||
## Screenshots:
|
||||
|
||||
<!---
|
||||
|
||||
Include a screenshot the before and after. This can be a screenshot of a plugin, web frontend, or output in a terminal.
|
||||
|
||||
-->
|
||||
|
||||
## Validation of changes:
|
||||
|
||||
<!---
|
||||
|
||||
Describe what tests have been added or amended, and why these demonstrate it works and will prevent this feature being accidentally broken by future changes.
|
||||
|
||||
-->
|
||||
|
||||
## Checklist:
|
||||
|
||||
<!---
|
||||
|
||||
This checklist is mostly useful as a reminder of small things that can easily be
|
||||
|
||||
forgotten – it is meant as a helpful tool rather than hoops to jump through.
|
||||
|
||||
Put an `x` between the square brackets, e.g. [x], for all the items that apply,
|
||||
|
||||
make notes next to any that haven't been addressed, and remove any items that are not relevant to this PR.
|
||||
|
||||
-->
|
||||
|
||||
- [ ] My pull request follows the guidelines in the [Contributing guide](https://github.com/specklesystems/speckle-server/blob/main/CONTRIBUTING.md)?
|
||||
- [ ] My pull request does not duplicate any other open [Pull Requests](../../pulls) for the same update/change?
|
||||
- [ ] My commits are related to the pull request and do not amend unrelated code or documentation.
|
||||
- [ ] My code follows a similar style to existing code.
|
||||
- [ ] I have added appropriate tests.
|
||||
- [ ] I have updated or added relevant documentation.
|
||||
|
||||
## References
|
||||
|
||||
<!---
|
||||
|
||||
(Optional -- remove this section if not needed )
|
||||
|
||||
Include **important** links regarding the implementation of this PR.
|
||||
|
||||
This usually includes a RFC or an aggregation of issues and/or individual conversations
|
||||
|
||||
that helped put this solution together. This helps ensure we retain and share knowledge
|
||||
|
||||
regarding the implementation, and may help others understand motivation and design decisions etc..
|
||||
|
||||
-->
|
||||
Reference in New Issue
Block a user