Skip to content
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 90 additions & 10 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,95 @@
The docs are built on GitHub Actions and run the ``.ci_scripts/update_docs`` script.
The docs are built on GitHub Actions and run the `.ci_scripts/update_docs` script.

To build the docs locally, follow the steps mentioned below:
1. Clone the repository into your local machine.
2. Go into the main folder and run the following commands.
3. ``conda env create -f ./.ci_scripts/environment.yml``
4. ``conda activate conda-forge-docs``
5. ``cd newsfeed && pip install --no-deps .``
6. ``cd ../src``
7. ``make html``

Documentation update PRs should only change the files in ``src``.
1. Clone the repository into your local machine.
2. Go into the main folder and run the following commands.

Once the PR is merged to ``master``, you can find the auto-generated html files in ``docs`` directory.
```
conda env create -f ./.ci_scripts/environment.yml
```

```
conda activate conda-forge-docs
```

```
cd newsfeed && pip install --no-deps .
```

```
cd ../src
```

```
make html
```

# Contributor NumFocus Code of Conduct
Comment thread
koachcode marked this conversation as resolved.
Outdated

## Scope

This code of conduct applies to all spaces managed by NumFOCUS, including all public and private mailing lists, issue trackers, wikis, forums, and any other communication channel used by our community. The code of conduct equally applies at NumFOCUS events and governs standards of behavior for attendees, speakers, volunteers, booth staff, and event sponsors.

## Our Dedication

NumFOCUS is dedicated to providing a harassment-free community for everyone, regardless of gender, sexual orientation, gender identity and expression, disability, physical appearance, body size, race, or religion. We do not tolerate harassment of community members in any form.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Be kind to others.
- Do not insult or put down others.
- Behave professionally.
- Remember that harassment and sexist, racist, or exclusionary jokes are not appropriate for NumFOCUS.
- All communication should be appropriate for a professional audience including people of many different backgrounds.

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery.
- Violent or intimidating threats or language directed against another person.
- Trolling or insulting and derogatory comments.
- Public or private harassment.
- Sharing private content, such as emails sent privately or non-publicly, or direct message history, without the sender’s consent.
- Posting sexually explicit or violent material.
- Other unethical or unprofessional conduct
- Advocating for, or encouraging, any of the above behaviors
Comment thread
koachcode marked this conversation as resolved.
Outdated

## Reporting a Misconduct
Comment thread
koachcode marked this conversation as resolved.
Outdated

- You can reach the Enforcement Team by emailing **conduct@numfocus.org.**

## Enforcement: What Happens After a Report is Filed

- Reviewing the Report.
- Contacting the Person Reported.
Comment thread
koachcode marked this conversation as resolved.
Outdated

## Response and Potential Consequences

- Nothing (if we determine that no violation occurred).
- Private feedback or reprimand from NumFOCUS to the individual(s) involved.
- Removing a person from NumFOCUS membership or other formal affiliation.
- Publishing an account of the harassment and calling for the resignation of the alleged harasser from their responsibilities (usually pursued by people without formal authority: may be called for if the person is the event leader, or refuses to stand aside from the conflict of interest, or similar)
- Any other response that NumFOCUS deems necessary and appropriate to the situation

Comment thread
koachcode marked this conversation as resolved.
_This code-of-conduct is common to the following projects:_

- _[staged-recipes](https://github.com/conda-forge/staged-recipes)_
- _[miniforge](https://github.com/conda-forge/miniforge)_
- _[conda-forge.github.io](https://github.com/conda-forge/conda-forge.github.io)_
- _[feedstocks](https://github.com/conda-forge/feedstocks)_
- _[conda-smithy](https://github.com/conda-forge/conda-smithy)_
- _[admin-requests](https://github.com/conda-forge/admin-requests)_
- _[conda-forge-repodata-patches-feedstock](https://github.com/conda-forge/conda-forge-repodata-patches-feedstock)_
- _[conda-forge-pinning-feedstock](https://github.com/conda-forge/conda-forge-pinning-feedstock)_
- _[docker-images](https://github.com/conda-forge/docker-images)_
- _[conda-forge-ci-setup-feedstock](https://github.com/conda-forge/conda-forge-ci-setup-feedstock)_
- _[marketing](https://github.com/conda-forge/marketing)_

## Attribution

This Code of Conduct is adapted from the [Contributor NumFocus][homepage]

[homepage]: https://numfocus.org/code-of-conduct