boost/website-v2-docs
2
0
Fork 0
mirror of https://github.com/boostorg/website-v2-docs.git synced 2026-01-19 04:42:17 +00:00
Code Issues Projects Releases Wiki Activity

CG: Outside Content added to Reporting Issues (#302)

Browse Source 
* Outside Content added to Reporting Issues

* Reporting Issues improved wording
This commit is contained in:
Peter Turcan
2024-08-16 17:01:15 -07:00
committed by GitHub
parent 2c9c92a20b
commit 27e267c32e
1 changed files with 20 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
contributor-guide/modules/ROOT/pages/getting-involved.adoc
View File

@@ -31,15 +31,32 @@ There are other mailing lists you might want to join, such as the https://lists.
== Report Issues and Suggest Improvements
There are different locations to report issues, depending on which content needs updated.
=== To Report an Issue with a Library
To formally report an issue on an individual library, locate the repo for that library. Many of these repos exist in the https://github.com/cppalliance/boost/tree/master/libs[Boost Super-project] on GitHub. Search under the `libs` folder. For example, to file an issue on the boost:json[] library, click *New Issue* at https://github.com/boostorg/json/issues[]. If you have difficulty locating the correct repo, then ask the question of the https://lists.boost.org/mailman/listinfo.cgi/boost[Boost developers' mailing list].
Before filing an issue, it is good practice to identify the admins (authors or maintainers) of a library. This information can be found in the `meta` folder for the library. For example: https://github.com/boostorg/json/blob/develop/meta/libraries.json[] contains the authors for the boost:json[] library. Also, library documentation and commit history may well specify who is actively involved. Make a connection first to ensure the library admins are open to updates.
To report an issue with the web site, including this documentation, click the *New Issue* button on this GitHub page: https://github.com/cppalliance/site-docs/issues[cppalliance/site-docs].
Whichever list you add your issue to, the issue will be triaged and addressed appropriately. Providing full details, and examples and screenshots where appropriate, should give you a quicker response.
After clicking *New Issue*, you will see a list of issue templates, such as *Submit a Correction or Bug report*, or *Suggest a Topic, Enhancement, or Information*. Select the most appropriate template (which will give you some advice on how to fill out the form), or select *Open a blank issue* if none of the templates applies.
=== To Report an Issue with an Outside Source
Whichever list you add your issue to, the issue will be addressed in due course. Providing full details, and examples and screenshots where appropriate, should give you the quicker response.
There are sources of information on the Boost libraries outside of this website and the library documentation, including:
* https://en.wikipedia.org/wiki/Boost_(C%2B%2B_libraries)[The Wikipedia page]
* https://www.linkedin.com/company/boostlibs/[The LinkedIn page]
* https://stackoverflow.com/questions/tagged/boost[Stack Overflow: Boost]
If you notice content that needs updated in these sources, perhaps out-of-date information, incorrect or missing information, or perhaps just language that could be improved, then complete the same process as *To Report an Issue with this Website*. Feedback like this is welcome.
[[createnewissue]]
=== To Report an Issue with this Website
To report an issue with the website, including this documentation, click the *New Issue* button on GitHub page: https://github.com/boostorg/website-v2-docs/issues[website-v2-docs/issues].
After clicking *New Issue*, you will be able to add a *Title* and *Description*. Provide as much detail as possible, including links where helpful and suggestions for the updated content.
[#contribute]
== Contribute to an Existing Library