Skip to content

Commit

Permalink
add markdown formater
Browse files Browse the repository at this point in the history
  • Loading branch information
Czaki committed Aug 1, 2023
1 parent 37ebe2d commit 032206a
Show file tree
Hide file tree
Showing 140 changed files with 2,510 additions and 2,418 deletions.
16 changes: 10 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
---
name: "\U0001F41B Bug Report"
______________________________________________________________________

name: "\\U0001F41B Bug Report"
about: Report typos, innacuracies or errors to help us improve the napari documentation
title: ''
labels: bug
assignees: ''

---
______________________________________________________________________

## 🐛 Bug

<!-- A clear and concise description of what the issue is. -->

<!-- Please provide the URL(s) of the page(s) that are problematic. -->

<!-- If you can, please add a screenshot or screen capture: "An image is worth a thousand words!" -->
<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->

<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->

## Environment

- Please copy and paste the information at napari info option in help menubar here:
- Please copy and paste the information at napari info option in help menubar here:

- Any other relevant information:
- Any other relevant information:

## Additional context

Expand Down
10 changes: 6 additions & 4 deletions .github/ISSUE_TEMPLATE/new_content.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
name: "\U0001F4DA New content request"
______________________________________________________________________

name: "\\U0001F4DA New content request"
about: Suggest new content pages to be added to the napari documentation
title: ''
labels: content
assignees: ''

---
______________________________________________________________________

## 📚 New content request
<!-- A clear and concise description of the content you'd like to see, and why this is important -->

<!-- A clear and concise description of the content you'd like to see, and why this is important -->

### Outline

<!-- Please include a rough outline of the document you are proposing -->
9 changes: 6 additions & 3 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
---
name: "\U0001F9F0 Task"
______________________________________________________________________

name: "\\U0001F9F0 Task"
about: Submit a proposal/request for improvements to workflows, documentation build or deployment.
title: ''
labels: task
assignees: ''

---
______________________________________________________________________

## 🧰 Task

<!-- A clear and concise description of the task -->
12 changes: 11 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,31 @@
# Description

<!-- What does this pull request (PR) do? Why is it necessary? -->

<!-- Tell us about your new content, improvement, or fix! -->

<!-- If you can, please add an image, or an animation "An image is worth a thousand words!" -->

<!-- You can use https://www.cockos.com/licecap/ or similar to create animations -->

<!-- You can also see a preview of the documentation changes you are submitting by clicking on "Details" to the right of the "Check the rendered docs here!" check on your PR.-->

## Type of change

<!-- Please delete options that are not relevant. -->

- [ ] Fixes or improves existing content
- [ ] Adds new content page(s)
- [ ] Fixes or improves workflow, documentation build or deployment

# References

<!-- What resources, documentation, and guides were used in the creation of this PR? -->

<!-- If this is a fix or otherwise resolves an issue, reference it here with "closes #(issue)" -->

## Final checklist:

- [ ] My PR is the minimum possible work for the desired functionality
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added [alt text](https://webaim.org/techniques/alttext/) to new images included in this PR
- [ ] I have added [alt text](https://webaim.org/techniques/alttext/) to new images included in this PR
10 changes: 5 additions & 5 deletions .github/TEST_FAIL_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "{{ env.TITLE }}"
labels: [bug]
---
______________________________________________________________________

## title: "{{ env.TITLE }}" labels: \[bug\]

The {{ workflow }} workflow failed on {{ date | date("YYYY-MM-DD HH:mm") }} UTC

The most recent failing test was on {{ env.PLATFORM }} py{{ env.PYTHON }} {{ env.BACKEND }}
with commit: {{ sha }}

Full run: https://github.com/{{ payload.repository.full_name }}/actions/runs/{{ env.RUN_ID }}

(This post will be updated if another test fails, as long as this issue remains open.)
(This post will be updated if another test fails, as long as this issue remains open.)
8 changes: 3 additions & 5 deletions .github/missing_translations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: [Automatic issue] Missing `_.trans()`.
labels: "good first issue"
---
______________________________________________________________________

## title: \[Automatic issue\] Missing `_.trans()`. labels: "good first issue"

It looks like one of our test cron detected missing translations.
You can see the latest output [here](https://github.com/napari/napari/actions/workflows/test_translations.yml).
Expand All @@ -11,4 +10,3 @@ You can also Update the cron script to update this issue with better information

Note that this issue will be automatically updated if kept open, or a new one will be created when necessary, if no open
issue is found and new `_.trans` call are missing.

8 changes: 8 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,11 @@ repos:
rev: v4.4.0
hooks:
- id: trailing-whitespace
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.16 # Use the ref you want to point at
hooks:
- id: mdformat
# Optionally add plugins
additional_dependencies:
- mdformat-gfm
- mdformat-black
5 changes: 3 additions & 2 deletions EULA.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@ https://napari.org.

<!-- Links -->

[napari_installers]: https://napari.org/stable/index.html#installation

<!-- List of EULAs starts here -->

<!--
Manually collected from the license artifacts found in the conda bundle CI.
Tip: Most licenses that need to be included are marked with a `LicenseRef-` prefix.
Expand Down Expand Up @@ -901,3 +900,5 @@ IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW.
exclusion or limitation of incidental, consequential or other
damages.
```

[napari_installers]: https://napari.org/stable/index.html#installation
3 changes: 2 additions & 1 deletion docs/api/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
(api)=

# API Reference

Information on specific functions, classes, and methods.

```{tableofcontents}
```
```
49 changes: 25 additions & 24 deletions docs/community/code_of_conduct.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
(napari-coc)=

# Code of Conduct

## Introduction
Expand All @@ -15,25 +16,25 @@ We strive to:

1. Be open. We invite anyone to participate in our community. We prefer to use public methods of communication for project-related messages, unless discussing something sensitive. This applies to messages for help or project-related support, too; not only is a public support request much more likely to result in an answer to a question, it also ensures that any inadvertent mistakes in answering are more easily detected and corrected.

2. Be empathetic, welcoming, friendly, and patient. We work together to resolve conflict, and assume good intentions. We may all experience some frustration from time to time, but we do not allow frustration to turn into a personal attack. A community where people feel uncomfortable or threatened is not a productive one.
1. Be empathetic, welcoming, friendly, and patient. We work together to resolve conflict, and assume good intentions. We may all experience some frustration from time to time, but we do not allow frustration to turn into a personal attack. A community where people feel uncomfortable or threatened is not a productive one.

3. Be collaborative. Our work will be used by other people, and in turn we will depend on the work of others. When we make something for the benefit of the project, we are willing to explain to others how it works, so that they can build on the work to make it even better. Any decision we make will affect users and colleagues, and we take those consequences seriously when making decisions.
1. Be collaborative. Our work will be used by other people, and in turn we will depend on the work of others. When we make something for the benefit of the project, we are willing to explain to others how it works, so that they can build on the work to make it even better. Any decision we make will affect users and colleagues, and we take those consequences seriously when making decisions.

4. Be inquisitive. Nobody knows everything! Asking questions early avoids many problems later, so we encourage questions, although we may direct them to the appropriate forum. We will try hard to be responsive and helpful.
1. Be inquisitive. Nobody knows everything! Asking questions early avoids many problems later, so we encourage questions, although we may direct them to the appropriate forum. We will try hard to be responsive and helpful.

5. Be careful in the words that we choose. We are careful and respectful in our communication and we take responsibility for our own speech. Be kind to others. Do not insult or put down other participants. We will not accept harassment or other exclusionary behaviour, such as:
1. Be careful in the words that we choose. We are careful and respectful in our communication and we take responsibility for our own speech. Be kind to others. Do not insult or put down other participants. We will not accept harassment or other exclusionary behaviour, such as:

> * Violent threats or language directed against another person.
> * Sexist, racist, ableist, or otherwise discriminatory jokes and language.
> * Posting sexually explicit or violent material.
> * Posting (or threatening to post) other people’s personally identifying information (“doxing”).
> * Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history, without the sender’s consent.
> * Personal insults, especially those using sexist, racist, or ableist terms.
> * Intentional or repeated misgendering of participants who have explicitly requested to be addressed by specific pronouns.
> * Unwelcome sexual attention.
> * Excessive profanity. Please avoid swearwords; people differ greatly in their sensitivity to swearing.
> * Repeated harassment of others. In general, if someone asks you to stop, then stop.
> * Advocating for, or encouraging, any of the above behaviour.
> - Violent threats or language directed against another person.
> - Sexist, racist, ableist, or otherwise discriminatory jokes and language.
> - Posting sexually explicit or violent material.
> - Posting (or threatening to post) other people’s personally identifying information (“doxing”).
> - Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history, without the sender’s consent.
> - Personal insults, especially those using sexist, racist, or ableist terms.
> - Intentional or repeated misgendering of participants who have explicitly requested to be addressed by specific pronouns.
> - Unwelcome sexual attention.
> - Excessive profanity. Please avoid swearwords; people differ greatly in their sensitivity to swearing.
> - Repeated harassment of others. In general, if someone asks you to stop, then stop.
> - Advocating for, or encouraging, any of the above behaviour.
## Diversity statement

Expand All @@ -53,13 +54,13 @@ For clearly intentional breaches, report those to the Code of Conduct committee

You can report issues to the napari Code of Conduct committee, at [email protected] . Currently, the committee consists of:

* [Juan Nunez-Iglesias](https://github.com/jni) (chair)
* [Nicholas Sofroniew](https://github.com/sofroniewn)
* [Kira Evans](https://github.com/kne42)
- [Juan Nunez-Iglesias](https://github.com/jni) (chair)
- [Nicholas Sofroniew](https://github.com/sofroniewn)
- [Kira Evans](https://github.com/kne42)

If your report involves any members of the committee, or if they feel they have a conflict of interest in handling it, then they will recuse themselves from considering your report. Alternatively, if for any reason you feel uncomfortable making a report to the committee, then you can also contact:

* [Charlotte Weaver](https://github.com/csweaver) at [email protected]
- [Charlotte Weaver](https://github.com/csweaver) at [email protected]

## Incident reporting resolution & Code of Conduct enforcement

Expand All @@ -73,17 +74,17 @@ In cases not involving clear severe and obvious breaches of this code of conduct

1. acknowledge report is received

2. reasonable discussion/feedback
1. reasonable discussion/feedback

3. mediation (if feedback didn’t help, and only if both reporter and reportee agree to this)
1. mediation (if feedback didn’t help, and only if both reporter and reportee agree to this)

4. enforcement via transparent decision (see [Resolutions](code_of_conduct_reporting.md#resolutions)) by the Code of Conduct Committee
1. enforcement via transparent decision (see [Resolutions](code_of_conduct_reporting.md#resolutions)) by the Code of Conduct Committee

The committee will respond to any report as soon as possible, and at most within 72 hours.

## Endnotes

We are thankful to the groups behind the following documents, from which we drew content and inspiration:

* [The SciPy Code of Conduct](https://docs.scipy.org/doc/scipy/dev/conduct/code_of_conduct.html)
* [The Numpy Code of Conduct](https://numpy.org/code-of-conduct/)
- [The SciPy Code of Conduct](https://docs.scipy.org/doc/scipy/dev/conduct/code_of_conduct.html)
- [The Numpy Code of Conduct](https://numpy.org/code-of-conduct/)
Loading

0 comments on commit 032206a

Please sign in to comment.