Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
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
19 changes: 19 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Code owners for Boost.Graph
#
# When a PR is opened, GitHub automatically requests review from the matching
# owners listed below. The order of rules matters: later, more specific rules
# override earlier, more general ones.
#
# Authoritative maintainer list: meta/libraries.json
# Contact details: CONTRIBUTING.md#maintainers

# Default reviewers for everything
* @jeremy-murphy @becheler

# Documentation, contributor-facing files, and CI configuration
/doc/ @becheler
/README.md @becheler
/CONTRIBUTING.md @becheler
/SECURITY.md @becheler
/CODE_OF_CONDUCT.md @becheler
/.github/ @becheler
83 changes: 83 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
name: Bug report
about: Report a defect or unexpected behavior in Boost.Graph
title: ''
labels: bug
assignees: ''
---

<!--
Thank you for taking the time to file a bug report. Please fill in as much
of the template below as you can. Reports without a reproducer or
environment details are very hard to triage.
-->

### Before filing

- [ ] I searched the [existing issues](https://github.com/boostorg/graph/issues?q=is%3Aissue) and did not find a duplicate.
- [ ] I have reproduced the bug against the `develop` branch or the latest Boost release.
- [ ] I have a minimal reproducer (or I will paste my full failing code below).

### Boost version

<!--
You can find the version number in `<boost/version.hpp>`, or by running
`git log -1` in your local Boost.Graph checkout.
-->

### Compiler family

- [ ] GCC / g++
- [ ] Clang / clang++
- [ ] MSVC (Visual Studio)
- [ ] Intel / oneAPI
- [ ] Other (specify below)

Exact compiler version: <!-- e.g. g++ 13.2.0, clang 17.0.6, MSVC 19.39 -->

### Standard library

- [ ] libstdc++
- [ ] libc++
- [ ] MSVC STL
- [ ] Other (specify below)

### Operating system

- [ ] Linux
- [ ] macOS
- [ ] Windows
- [ ] Other (specify below)

### Kind of component affected

- [ ] Graph data structure (e.g. `adjacency_list`, `adjacency_matrix`)
- [ ] Algorithm (e.g. `dijkstra_shortest_paths`, `breadth_first_search`)
- [ ] Property map
- [ ] I/O or file-format reader (e.g. `read_graphml`, `read_graphviz`)
- [ ] Visitor / event hooks
- [ ] Other (specify below)

Exact name of the affected component: <!-- e.g. dijkstra_shortest_paths -->

### Steps to reproduce

<!--
A minimal compiling program that demonstrates the problem is ideal.
A [Compiler Explorer](https://godbolt.org/z/9Esszr9Ga) link is even better.
-->

### Expected behavior

### Actual behavior

<!--
Include compiler error messages or runtime output verbatim, with file and
line numbers where applicable.
-->

### Are you willing to help?

- [ ] I'd like to submit a fix as a pull request.
- [ ] I can help diagnose or test a candidate fix.
- [ ] I'm only reporting the issue.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
blank_issues_enabled: false
contact_links:
- name: Design discussion or open-ended question
url: https://github.com/boostorg/graph/discussions
about: |
For "should we...?" questions, design exploration, or anything not
yet a concrete proposal, please start a GitHub Discussion. Issues
are reserved for bugs, feature requests with a concrete proposal,
and documentation problems.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Documentation issue
about: Report missing, incorrect, or unclear documentation
title: ''
labels: docs
assignees: ''
---

<!--
Documentation problems are real bugs. Thanks for taking the time to
report one.
-->

### Before filing

- [ ] I searched the [existing issues](https://github.com/boostorg/graph/issues?q=is%3Aissue+label%3Adocs) and did not find a duplicate.
- [ ] I checked the latest version of the documentation on `develop`.

### Kind of problem

- [ ] Documentation is missing entirely
- [ ] Documentation is incorrect or out of date
- [ ] Explanation is unclear or confusing
- [ ] Example does not compile
- [ ] Example compiles but does not produce the documented result
- [ ] Dead link or broken cross-reference
- [ ] Other (specify below)

### Where is the issue?

<!--
A link to the page, or the path to the file (for example,
`doc/quick_tour.html` or `include/boost/graph/dijkstra_shortest_paths.hpp`).
-->

### What is wrong, missing, or unclear?

<!--
For example: an example does not compile, an algorithm's complexity is
not stated, a parameter is undocumented, an explanation is confusing.
-->

### What did you expect to find?

<!-- What information would have helped you? -->

### Suggested wording (optional)

<!--
If you already have an idea of what the docs should say, paste a draft
here.
-->

### Are you willing to help?

- [ ] I'd like to submit a docs pull request.
- [ ] I can review a candidate fix.
- [ ] I'm only reporting the issue.
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
name: Feature request
about: Suggest a new algorithm, API addition, or enhancement
title: ''
labels: enhancement
assignees: ''
---

<!--
Thanks for proposing an addition to Boost.Graph.

If you want to explore an idea or discuss whether a feature would be
worthwhile before committing to a concrete proposal, please start a
GitHub Discussion instead:
https://github.com/boostorg/graph/discussions

This template is for requests with a clear, actionable proposal: a
specific algorithm, API, or enhancement that a maintainer could
reasonably implement or review.
-->

### Before filing

- [ ] I searched the [existing issues](https://github.com/boostorg/graph/issues?q=is%3Aissue) and did not find a duplicate.
- [ ] This is a concrete proposal, not an open-ended design question.

### Kind of addition

- [ ] New algorithm
- [ ] New data structure
- [ ] New property map or utility
- [ ] New I/O format reader or writer
- [ ] Extension to an existing component
- [ ] Performance improvement
- [ ] Other (specify below)

### Motivation

<!--
What problem does this feature solve? Who would use it, and in what
context?
-->

### Proposed addition

<!--
A new algorithm, a new data structure, an extension to an existing
component, or something else? If you have a rough API sketch, paste it
here.
-->

### Relation to existing Boost.Graph components

<!--
Does this overlap with or build on something that already exists in the
library (for example, an existing algorithm or property map)?
-->

### Prior art

- [ ] Reference paper or textbook (cite below)
- [ ] Implementation in another library (link below)
- [ ] None / original idea

References: <!-- paste DOI, ISBN, or URL -->

### Are you willing to contribute?

- [ ] I'd like to submit the implementation as a pull request.
- [ ] I can help with review or testing, but not the implementation.
- [ ] I'm only proposing the idea.
50 changes: 50 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<!--
Thanks for contributing to Boost.Graph! A few notes before you fill this in:

* Target the `develop` branch.
* New contributions must be licensed under the
[Boost Software License 1.0](https://www.boost.org/LICENSE_1_0.txt).
* Please link any related issue with `Fixes #N` or `Refs #N`.
-->

### Before submitting

- [ ] This PR targets the `develop` branch.
- [ ] I searched for an existing PR or issue covering the same change.
- [ ] My contribution is licensed under the Boost Software License 1.0.

### Type of change

- [ ] Bug fix
- [ ] New feature or API addition
- [ ] Refactor (no behavior change)
- [ ] Documentation
- [ ] Build, CI, or tooling
- [ ] Other (specify below)

### Does this PR introduce a breaking change?

- [ ] Yes (describe migration impact below)
- [ ] No

### What this PR does

<!-- A short summary of the change. -->

### Motivation

<!-- Why is this needed? Link related issue with `Fixes #N` or `Refs #N`. -->

### Testing

<!--
How did you verify the change? Which compilers and standard libraries did
you build against? Were new tests added under `test/`?
-->

### Checklist

- [ ] Existing tests pass (`b2` in the `test/` directory).
- [ ] New behavior is covered by a test, or this is a docs / build / refactor change.
- [ ] Documentation was updated if user-facing behavior changed.
- [ ] No new compiler warnings on the platforms I built against.
84 changes: 84 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at `arnaud.becheler -at- gmail.com`. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
Loading
Loading