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.

Members fund testing for the Drupal project. Drupal Association Learn more

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

mgifford’s picture

I like this idea. Neat suggestion by Github. Thanks for getting this started Matt!

I'd suggest:

- Adding a section for accessibility.
- Adding something about social media. "Thank those users or the projects that make your work a success"
- Could also ask folks to blog about it and add links back to the projects they use

@naveenvalecha good point. Maybe best to point to https://www.drupal.org/docs/8 for now. Though really not sure that the D8 docs have a
Theming HowTo that is updated.

@dawehner 1. agreed. Who uses Mailing lists? 2. I'd agree that it should focus on the core specific issues. I do think though that core does have a responsibility to point people to broader Drupal issues.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.