Update contributing documentation. Add new issue templates. #4327
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
janette
force-pushed
the
contributing-docs
branch
5 times, most recently
from
66b4ad4 to
959dd9a
Compare
rovcase
approved these changes
Dec 10, 2024
| - type: textarea | ||
| attributes: | ||
| label: Description | ||
| description: A concise description of the task or suggested implementation. |
There was a problem hiding this comment.
Nitpicking: I'm a stickler for using the word in the description/definition of something, so maybe: "A concise explanation of the task or suggested implementation."
| - type: textarea | ||
| attributes: | ||
| label: Acceptance Criteria | ||
| description: Tell us what should happen, how will we know when we're done. |
There was a problem hiding this comment.
Nitpicking: "Tell us what should happen when the task is completed. How will we know when we're done?"
| -------------------------------------- | ||
|
|
||
| We recomend using DDEV with the DDEV-DKAN add-on as there are many helpful commands that will make it easier to get started. | ||
| Once you have composer, docker, and DDEV `installed <https://dkan.readthedocs.io/en/latest/installation/index.html>`_, head over to `Getting Started with DDEV-DKAN <https://getdkan.github.io/ddev-dkan/getting-started.html>`_ |
There was a problem hiding this comment.
Period at the end of this for consistencies sake. "Getting started with DDEV-DKAN."
| Coding Standards | ||
| ---------------- | ||
|
|
||
| `Coder <http://drupal.org/project/coder>`_ is a tool to help write code for Drupal modules. It can detect and automatically fix coding standard errors. The project provides a coding standard for PHP_CodeSniffer based on the `Drupal coding standard <https://www.drupal.org/docs/develop/standards/php/php-coding-standards>`_ |
There was a problem hiding this comment.
Period at the end of here too: "Drupal coding standard."
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
QA Steps