Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add SUPPORT.md (helps point users from GitHub to appropriate support resources) #6171

Merged
merged 4 commits into from Apr 25, 2022

Conversation

grlee77
Copy link
Contributor

@grlee77 grlee77 commented Jan 7, 2022

Description

closes #6058

A link to this should pop up for new contributors on the issues page. There will also be a small "support" link under the "Helpful resources" section at the bottom right of the Issues, PR or Discussions pages as well. At the moment this section has "Contributing", "Code of conduct" and "GitHub Community Guidelines" links. After this PR there would also be a "support" link there as well.

The exact text to use here will depend on decisions made in #6167, so I have marked this as a draft for now.

Checklist

  • Docstrings for all functions
  • Gallery example in ./doc/examples (new features only)
  • Benchmark in ./benchmarks, if your changes aren't covered by an
    existing benchmark
  • Unit tests
  • Clean style in the spirit of PEP8
  • Descriptive commit messages (see below)

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in
    doc/release/release_dev.rst.

A link to this will pop up for new contributors on the issues page.
There is also a small "support" link under the "Helpful resources"
section at the bottom right of the Issues, PR or Discussions pages
as well.
@grlee77 grlee77 added the 📄 type: Documentation Updates, fixes and additions to documentation label Jan 7, 2022
.github/SUPPORT.md Outdated Show resolved Hide resolved
.github/SUPPORT.md Outdated Show resolved Hide resolved
.github/SUPPORT.md Outdated Show resolved Hide resolved
.github/SUPPORT.md Outdated Show resolved Hide resolved
.github/SUPPORT.md Outdated Show resolved Hide resolved
@mkcor
Copy link
Member

mkcor commented Feb 22, 2022

@grlee77 do you mind removing lines 3--6 of .github/ISSUE_TEMPLATE.md in this PR as well?

I'm going through the notes from the last community meeting...

.github/SUPPORT.md Outdated Show resolved Hide resolved
Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
@grlee77 grlee77 marked this pull request as ready for review February 23, 2022 03:36
@grlee77
Copy link
Contributor Author

grlee77 commented Feb 23, 2022

@grlee77 do you mind removing lines 3--6 of .github/ISSUE_TEMPLATE.md in this PR as well?

I think we may as well leave that there as well. Some people might miss the SUPPORT.md info in the right bar, but notice that one?

.github/SUPPORT.md Outdated Show resolved Hide resolved
@mkcor
Copy link
Member

mkcor commented Feb 23, 2022

I think we may as well leave that there as well. Some people might miss the SUPPORT.md info in the right bar, but notice that one?

You are right; it doesn't hurt! :shipit:

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
@grlee77 grlee77 merged commit a8322d4 into scikit-image:main Apr 25, 2022
alexdesiqueira pushed a commit to alexdesiqueira/scikit-image that referenced this pull request May 24, 2022
…resources) (scikit-image#6171)

* add SUPPORT.md

A link to this will pop up for new contributors on the issues page.
There is also a small "support" link under the "Helpful resources"
section at the bottom right of the Issues, PR or Discussions pages
as well.

Co-authored-by: Marianne Corvellec <marianne.corvellec@ens-lyon.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 type: Documentation Updates, fixes and additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add SUPPORT file to help users
3 participants