Problem/Motivation

Github recently added new community tools which lints projects for their own open-source community recommendations, one of which is that "a CONTRIBUTING file tells your audience how to participate in your project.".

Proposed resolution

Add a core/CONTRIBUTING.txt to Drupal's repository, with the contents of Drupal's Ways to get involved documentation.

I suggest putting it in whichever folder holds MAINTAINERS.txt (i.e.: another piece of documentation you'd probably want to read if you wanted to interact with the Drupal community). In Drupal 8, MAINTAINERS.txt is in the core sub-directory; in Drupal 7 MAINTAINERS.txt is in the root folder.

I suggest we make it a .txt (as opposed to a markdown document / .md) to be consistent with other documentation in that directory.

I suggest we use the text from https://www.drupal.org/contribute because:

  1. that's a pretty comprehensive jumping-off point regardless of the reader's specialty (i.e.: it's for more than just developers),
  2. the text on that page doesn't change as often as the pages it links to (i.e.: less work to keep the file in-sync with the page on d.o), and,
  3. we have a lot of documentation on contributing, arguably more than we can reasonably expect someone to read in a single file.

Remaining tasks

  1. Write a patch
  2. Review and feedback
  3. RTBC and feedback
  4. Commit
  5. Discuss how to backport to 7.x

User interface changes

None.

API changes

None.

Data model changes

None.

Comments

mparker17 created an issue. See original summary.

mparker17’s picture

Assigned: mparker17 » Unassigned
Issue summary: View changes
Status: Active » Needs review
FileSize
4.5 KB

Here's a patch for the 8.4.x branch. Reviews welcome!

mparker17’s picture

Issue tags: +Novice

(tagging as a novice issue)

mparker17’s picture

Issue summary: View changes

(formatting changes to the issue summary)

naveenvalecha’s picture

+++ b/core/CONTRIBUTING.txt
@@ -0,0 +1,109 @@
+  https://www.drupal.org/docs/7/theming/howto/customizing-core-andor-contributed-themes

Do we have the documentation page for Drupal 8?

mparker17’s picture

@naveenvalecha, the link was copied directly from https://www.drupal.org/contribute : I'm tempted to say that's a discussion for the maintainers of that documentation page. For reference, the D8 theming guide is at https://www.drupal.org/docs/8/theming

dawehner’s picture

just some drive by review

  1. +++ b/core/CONTRIBUTING.txt
    @@ -0,0 +1,109 @@
    +- Mailing lists: https://www.drupal.org/mailing-lists
    

    I think we should point to IRC/Slack instead

  2. +++ b/core/CONTRIBUTING.txt
    @@ -0,0 +1,109 @@
    +- Issue tracker: https://www.drupal.org/project/issues
    

    This points to all issues instead of the core specific ones