From 9b9099318da82295930851436195ed903dfa37c8 Mon Sep 17 00:00:00 2001 From: David Blane <32327139+dblane-digicatapult@users.noreply.github.com> Date: Fri, 24 May 2024 11:34:35 +0100 Subject: [PATCH] Removed CONTRIBUTING.md, CODE_OF_CONDUCT.md, .github/ISSUE_TEMPLATE, and .github/PULL_REQUEST_TEMPLATE.md to centralize templates (#175) --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 46 ------- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 29 ----- .github/PULL_REQUEST_TEMPLATE.md | 11 -- CODE_OF_CONDUCT.md | 46 ------- CONTRIBUTING.md | 151 ---------------------- 5 files changed, 283 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md delete mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md deleted file mode 100644 index a4dddb4f..00000000 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve ---- - - - -### Prerequisites - -- [ ] Put an X between the brackets on this line if you have done all of the following: - - Checked the FAQs for common solutions: - - Checked that your issue isn't already filed: - -### Description - - - -### Steps to Reproduce - -1. -2. -3. - -**Expected behaviour:** - - - -**Actual behaviour:** - - - -**Reproduces how often:** - - - -### Versions - - - -### Additional Information - - diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md deleted file mode 100644 index d59c9776..00000000 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project ---- - - - -## Summary - - - -## Motivation - - - -## Describe alternatives you've considered - - - -## Additional context - - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c299e372..00000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,11 +0,0 @@ -βš›πŸ‘‹ Hello there! Welcome. Please follow the steps below to tell us about your contribution. - -Copy the correct template for your contribution - -πŸ› Are you fixing a bug? Copy the template from https://github.com/digicatapult/sqnc-node/blob/main/.github/ISSUE_TEMPLATE/bug_report.md -πŸ’» Are you changing functionality? Copy the template from https://github.com/digicatapult/sqnc-node/blob/main/.github/ISSUE_TEMPLATE/feature_request.md -Replace this text with the contents of the template - -Fill in all sections of the template - -Click "Create pull request" diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index ae7c7494..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,46 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project, and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behaviour that contributes to creating a positive environment include: - -- Using welcoming and inclusive language -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community -- Showing empathy towards other community members - -Examples of unacceptable behaviour by participants include: - -- The use of sexualized language or imagery and unwelcome sexual attention or advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic address, without explicit permission -- Other conduct which could reasonably be considered inappropriate in a professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable behaviour and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behaviour. - -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at [opensource@digicatapult.org.uk](mailto:opensource@digicatapult.org.uk?subject=Veritable). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team's obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. - -## Attribution - -This Code of Conduct has been adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version] - -[homepage]: https://contributor-covenant.org -[version]: https://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index c2d880ce..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,151 +0,0 @@ -# Contributing to veritable-node - -Firstly, we would like to thank you for taking the time to contribute! - -The following is a set of guidelines for contributing to Veritable and its packages, which are hosted on the [digicatapult](https://github.com/digicatapult) organisation on GitHub. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request. - -#### Table Of Contents - -[Code of Conduct](#code-of-conduct) - -[FAQs](#FAQs) - -[How Can I Contribute?](#how-can-i-contribute) - -- [Reporting Bugs](#reporting-bugs) -- [Suggesting Enhancements](#suggesting-enhancements) -- [Your First Code Contribution](#your-first-code-contribution) -- [Pull Requests](#pull-requests) - -[Styleguides](#styleguides) - -- [Git Commit Messages](#git-commit-messages) -- [Pull Request Labels](#pull-request-labels) - -## Code of Conduct - -This project and all those participating in it are governed by the [Digital Catapult's Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behaviour to [opensource@digicatapult.org.uk](mailto:opensource@digicatapult.org.uk?subject=Veritable). - -## FAQs - -We don't have any frequently asked questions yet. - -## How Can I Contribute? - -### Reporting Bugs - -This section guides you through submitting a bug report for veritable-node. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behaviour :computer: :computer:, and find related reports :mag_right:. - -Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](https://github.com/digicatapult/sqnc-node/blob/main/.github/ISSUE_TEMPLATE/bug_report.md), the information it asks for helps us resolve issues faster. - -> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. - -#### Before Submitting A Bug Report - -- **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Asqnc-node)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. - -#### How Do I Submit A (Good) Bug Report? - -Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information by filling in [the template](https://github.com/digicatapult/sqnc-node/.github/blob/main/.github/ISSUE_TEMPLATE/bug_report.md). - -Explain the problem and include additional details to help maintainers reproduce the problem: - -- **Use a clear and descriptive title** for the issue to identify the problem. -- **Describe the exact steps which reproduce the problem** in as many details as possible. -- **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). -- **Describe the behaviour you observed after following the steps** and point out what exactly is the problem with that behaviour. -- **Explain which behaviour you expected to see instead and why.** -- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. If you use the keyboard while following the steps, \*\*record the GIF with the [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/Xaviju/byzanzUI) on Linux. -- **If you're reporting that veritable-node crashed**, include a crash report with a stack trace from the operating system. On macOS, the crash report will be available in `Console.app` under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a [code block](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) and provide link to that gist. -- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below. - -Provide more context by answering these questions: - -- **Did the problem start happening recently** (e.g. after updating to a new version of veritable-node) or was this always a problem? -- If the problem started happening recently, **can you reproduce the problem in an older version of veritable-node?** What's the most recent version in which the problem doesn't happen? You can checkout older versions of veritable-node from [the releases page](https://github.com/digicatapult/sqnc-node/releases). -- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens. - -Include details about your configuration and environment: - -- **Which version of veritable-node are you using?** You can get the exact version from the version attribute within package.json. -- **What's the name and version of the OS you've deployed veritable-node to**? -- **Are you running veritable-node in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest? - -### Suggesting Enhancements - -This section guides you through submitting an enhancement suggestion for veritable-node, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:. - -Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](https://github.com/digicatapult/sqnc-node/blob/main/.github/ISSUE_TEMPLATE/feature_request.md), including the steps that you imagine you would take if the feature you're requesting existed. - -#### Before Submitting An Enhancement Suggestion - -- **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Asqnc-node)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. - -#### How Do I Submit A (Good) Enhancement Suggestion? - -Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information: - -- **Use a clear and descriptive title** for the issue to identify the suggestion. -- **Provide a step-by-step description of the suggested enhancement** in as many details as possible. -- **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). -- **Describe the current behaviour** and **explain which behaviour you expected to see instead** and why. -- **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of veritable-node which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. -- **Explain why this enhancement would be useful** to most veritable-node users. -- **List some other text editors or applications where this enhancement exists.** -- **Specify which version of veritable-node you're using.** You can get the exact version from the version attribute within package.json. -- **What's the name and version of the OS you've deployed veritable-node to**? - -### Pull Requests - -The process described here has several goals: - -- Maintain veritable-node's quality -- Fix problems that are important to users -- Enable a sustainable system for veritable-node's maintainers to review contributions - -Please follow these steps to have your contribution considered by the maintainers: - -1. Follow all instructions in [the template](.github/PULL_REQUEST_TEMPLATE.md) -2. Follow the [styleguides](#styleguides) -3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing
What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
- -While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. - -## Styleguides - -### Git Commit Messages - -- Use the present tense ("Add feature" not "Added feature") -- Use the imperative mood ("Move cursor to..." not "Moves cursor to...") -- Limit the first line to 72 characters or less -- Reference issues and pull requests liberally after the first line -- Consider starting the commit message with an applicable emoji: - - :art: `:art:` when improving the format/structure of the code - - :racehorse: `:racehorse:` when improving performance - - :non-potable_water: `:non-potable_water:` when plugging memory leaks - - :memo: `:memo:` when writing docs - - :penguin: `:penguin:` when fixing something on Linux - - :apple: `:apple:` when fixing something on macOS - - :checkered_flag: `:checkered_flag:` when fixing something on Windows - - :bug: `:bug:` when fixing a bug - - :fire: `:fire:` when removing code or files - - :green_heart: `:green_heart:` when fixing the CI build - - :white_check_mark: `:white_check_mark:` when adding tests - - :lock: `:lock:` when dealing with security - - :arrow_up: `:arrow_up:` when upgrading dependencies - - :arrow_down: `:arrow_down:` when downgrading dependencies - - :shirt: `:shirt:` when removing linter warnings - -### Pull Request Labels - -| Label name | :mag_right: | Description | -| ----------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------ | -| `breaking-change` | [search][search-digicat-label-breaking-change] | Pull requests that add functionality with incompatible API changes (MAJOR SemVer) | -| `feature ` | [search][search-digicat-label-feature] | Pull requests that add functionality with backwards compatibility (MINOR SemVer) | -| `chore` | [search][search-digicat-label-chore] | Simple changes or improvements to the code base so it can be worked with more easily | -| `bug` | [search][search-digicat-label-bug] | Pull requests that fix bugs | - -[search-digicat-label-breaking-change]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Abreaking-change -[search-digicat-label-feature]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Afeature -[search-digicat-label-chore]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Achore -[search-digicat-label-bug]: https://github.com/search?q=is%3Apr+user%3Adigicatapult+label%3Abug