Skip to content

Commit e4ccd8e

Browse files
authored
Update CONTRIBUTING and Build Testing docs (#590)
Signed-off-by: David Hoyt <dhoyt@hoyt.net>
1 parent 260b499 commit e4ccd8e

File tree

3 files changed

+53
-20
lines changed

3 files changed

+53
-20
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,27 @@ We require all participants to abide by our [Code of Conduct](CODE_OF_CONDUCT.md
1818

1919
## Get Connected
2020

21-
The first thing to do, before anything else, is to talk to us! Whether you are reporting an issue, requesting or implementing a feature, or just asking a question, please don’t hesitate to reach out to project maintainers or the community as a whole. This is an important first step because your issue, feature, or question may have been solved or discussed already, and you will save yourself a lot of time by asking first.
21+
The first thing to do, before anything else, is to talk to us! Whether you are reporting an issue, requesting or implementing a feature, or just asking a question, please don’t hesitate to reach out to the project maintainers or the community. This is an important first step because your issue, feature, or question may have been solved or discussed already, and you will save yourself a lot of time by asking first.
2222

23-
How do you talk to us? There are several ways to get in touch:
23+
**Before opening a Pull Request, please start a conversation with us.**
24+
All Pull Requests should be tied to an existing Issue that discusses the problem or feature being addressed. This helps ensure the change aligns with project goals and prevents wasted effort on work that may already be in progress or out of scope.
2425

25-
* [GitHub Issues](https://github.com/InternationalColorConsortium/iccDev/issues):
26-
GitHub **issues** are a great place to start a conversation! Issues aren’t
27-
restricted to bugs; we happily welcome feature requests and other suggestions
28-
submitted as issues. The only conversations we would direct away from issues are
29-
questions in the form of “How do I do X”. Those questions should be discussed on the ICC Members Mailing List.
26+
### How do you talk to us?
27+
28+
* [GitHub Issues](https://github.com/InternationalColorConsortium/iccDev/issues)
29+
GitHub **issues** are the primary place for project discussion. Issues aren’t
30+
restricted to bugs; we happily welcome feature requests and other suggestions
31+
submitted as issues. Opening an issue is the expected first step before
32+
submitting a Pull Request.
33+
34+
* [GitHub Discussions](https://github.com/InternationalColorConsortium/iccDev/discussions)
35+
GitHub **Discussions** are the place for open-ended conversation and exploration.
36+
Use Discussions to ask questions, float new ideas, firm up enhancement proposals,
37+
or gather feedback before opening an Issue or Pull Request.
38+
39+
The only conversations we would direct away from GitHub are questions in the
40+
form of “How do I do X with ICC profiles”. Those questions should be discussed on
41+
the ICC Members Mailing List.
3042

3143
## Legal Requirements
3244

docs/build.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
# Building iccDEV
22

3-
## Quickstart installation:
4-
5-
| Method | Command |
6-
|--------|---------|
7-
| **Homebrew** | `brew install iccdev` |
8-
| **NPM** | `npm install iccdev` |
9-
| **Docker Pull** | `docker pull ghcr.io/internationalcolorconsortium/iccdev:latest` |
10-
| **Docker Run** | `docker run -it ghcr.io/internationalcolorconsortium/iccdev:latest` |
3+
iccDEV requires C++17 or higher to compile.
114

125
## Required libraries
136

@@ -17,13 +10,11 @@
1710
| **Windows** | libpng, libjpeg-turbo, libtiff, libxml2, wxwidgets, nlohmann-json |
1811
| **Linux (Ubuntu)** | libpng-dev, libjpeg-dev, libtiff-dev, libxml2-dev, wxwidgets*, nlohmann-json |
1912

13+
## Ubuntu
14+
2015
\* **Note:** On Ubuntu, `wxwidgets` is installed via distribution-specific development packages
2116
(e.g. `libwxgtk3.2-dev`). Refer to the `apt install` command below for the exact package names.
2217

23-
iccDEV requires C++17 or higher to compile.
24-
25-
26-
## Ubuntu
2718

2819
```
2920
export CXX=clang++
@@ -58,4 +49,23 @@ cmake --preset vs2022-x64 -B . -S Build/Cmake
5849
cmake --build . -- /m /maxcpucount
5950
```
6051

61-
---
52+
### Reporting Build Issues
53+
54+
Before submitting a PR for build failures:
55+
56+
1. Test local environment:
57+
- Build in a clean container/VM
58+
- Open an Issue first
59+
- Utilize Testing Scripts
60+
- [Unix](https://github.com/InternationalColorConsortium/iccDEV/blob/research/contrib/HelperScripts/unix-issue-template.sh)
61+
```
62+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/InternationalColorConsortium/iccDEV/refs/heads/research/contrib/HelperScripts/unix-pr-review.sh)"
63+
```
64+
- [Windows](https://raw.githubusercontent.com/InternationalColorConsortium/iccDEV/refs/heads/research/contrib/HelperScripts/windows-pr-review.ps1)
65+
```
66+
iex (iwr -Uri "https://raw.githubusercontent.com/InternationalColorConsortium/iccDEV/refs/heads/research/contrib/HelperScripts/windows-issue-template.ps1").Content
67+
```
68+
69+
2. Open or Update an Issue with the script output.
70+
71+
3. [CI](https://github.com/InternationalColorConsortium/iccDEV/actions/workflows/ci-latest-release.yml) provides the latest builds for macOS, Windows & Linux.

docs/install.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Quickstart installation:
2+
3+
| Method | Command |
4+
|--------|---------|
5+
| **Homebrew** | `brew install iccdev` |
6+
| **NPM** | `npm install iccdev` |
7+
| **Docker Pull** | `docker pull ghcr.io/internationalcolorconsortium/iccdev:latest` |
8+
| **Docker Run** | `docker run -it ghcr.io/internationalcolorconsortium/iccdev:latest` |
9+
10+
## Build Instructions
11+
Build instructions are available in [docs/build.md](docs/build.md).

0 commit comments

Comments
 (0)