From b579a5b3fa4633cd19b72f72a43313915168dfeb Mon Sep 17 00:00:00 2001 From: Vladimir <48120135+izmalk@users.noreply.github.com> Date: Mon, 2 Feb 2026 15:54:59 +0000 Subject: [PATCH 1/4] Intial update (WIP) --- CONTRIBUTING.md | 66 +++++++++++++++++++++++++++++++------------------ 1 file changed, 42 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e564ad7..240a8e72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,30 +1,48 @@ -## How to contribute - -Help from community is necessary to make any opensource project great. We want to keep it as easy as possible for community to contribute changes. There are a few guidlines that we need to follow so that it is easy for others to understand and change the codebase. - -### Getting Started -* Setup jekyll environment. You can follow [this link](https://jekyllrb.com/docs/). -* Now, you have a working jekyll environment. Clone the source code from [github](https://github.com/OpenPrinting/openprinting.github.io). -* Go to the directory and run: -``` -bundle exec jekyll serve -``` -* If you want to access website from some other device on local network, use: -``` -bundle exec jekyll serve --host=0.0.0.0 -``` -* Open ``` localhost:4000 ``` - -### Issues -* If you want to work on some issue, first comment on that issue that you want to work. -* If you want to open a new Issue. First make sure similiar issue is not present. -* In case of a bug, always mention browser you are using because different browsers may behave differently. -* In case of an Idea, please mention how it will change user experience and/or how it will enhance functionality of the website. +# How to contribute + +Community support is essential to making any open-source project successful. We aim to keep contributing as simple as possible, while following a few guidelines so others can easily understand and maintain the codebase. + +## General process + +Our documentation is published on the https://openprinting.github.io/ address and stored +in the [openprinting.github.io repository](https://github.com/OpenPrinting/openprinting.github.io). +All the common documentation pages are published in the +[Documentation section](https://openprinting.github.io/documentation/) and stored +in the `_documentation` directory. + +Documentation for individual components is kept in each component’s repository, +usually in a doc directory. + +To contribute, fork the relevant repository and open a pull request with your proposed changes. +The pull request will be automatically assigned to reviewers. +Include a clear, meaningful description of what you changed and why. + +If your pull request hasn’t received any review activity after a week, feel free to contact us. + +### Issues workflow + +Use these guidelines when working with issues: + +* If you want to work on an issue, comment on it first to let others know you’re taking it. +* Before opening a new issue, check whether a similar issue already exists. +* For bug reports, include the browser (and version) you’re using, since behavior may differ across browsers. +* For ideas or feature requests, explain how the change will affect the user experience and/or improve the website’s functionality. ### Pull Requests + * If you have made some changes in the codebase and want to generate a PR. First, pull latest version of code from [upstream](https://github.com/Esri/developer-support/wiki/Setting-the-upstream-for-a-fork). Remove all merge conflicts before generating PR. * In the PR, try to add working link of your work and if that is not possible, add screenshots. ### Making changes -* Whenever you are working on some major feature, always create a [new branch](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging). -* Whenever you add something above trivial, please add comments. \ No newline at end of file + + +* Whenever you are working on some major feature, always create a [new branch](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging). + +## Build docs + +To build our documentation locally: + +* Setup jekyll environment. See the [official documentation](https://jekyllrb.com/docs/) for guidance. +* Clone the source code from [Github](https://github.com/OpenPrinting/openprinting.github.io). +* Navigate to the local repository and run: `bundle exec jekyll serve` +* Open the localhost address in your web browser: `localhost:4000` From 5284156c8a905b46daddf1a1df085c3768258a78 Mon Sep 17 00:00:00 2001 From: Vladimir <48120135+izmalk@users.noreply.github.com> Date: Mon, 2 Feb 2026 17:15:35 +0000 Subject: [PATCH 2/4] Finishing the file review --- CONTRIBUTING.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 240a8e72..244455dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,13 @@ # How to contribute -Community support is essential to making any open-source project successful. We aim to keep contributing as simple as possible, while following a few guidelines so others can easily understand and maintain the codebase. +Community support is essential to making any open-source project successful. +We aim to keep contributing as simple as possible. +However, following a few guidelines shown before helps +others understand and maintain the codebase. ## General process -Our documentation is published on the https://openprinting.github.io/ address and stored +Our documentation is published at https://openprinting.github.io/ and stored in the [openprinting.github.io repository](https://github.com/OpenPrinting/openprinting.github.io). All the common documentation pages are published in the [Documentation section](https://openprinting.github.io/documentation/) and stored @@ -19,7 +22,11 @@ Include a clear, meaningful description of what you changed and why. If your pull request hasn’t received any review activity after a week, feel free to contact us. -### Issues workflow +## Issues workflow + +If you spot a problem or bug, please open an issue. +Reporting and documenting issues is a valuable contribution, +even if you’re not able to fix them yourself. Use these guidelines when working with issues: @@ -28,21 +35,23 @@ Use these guidelines when working with issues: * For bug reports, include the browser (and version) you’re using, since behavior may differ across browsers. * For ideas or feature requests, explain how the change will affect the user experience and/or improve the website’s functionality. -### Pull Requests +## Pull requests -* If you have made some changes in the codebase and want to generate a PR. First, pull latest version of code from [upstream](https://github.com/Esri/developer-support/wiki/Setting-the-upstream-for-a-fork). Remove all merge conflicts before generating PR. -* In the PR, try to add working link of your work and if that is not possible, add screenshots. +Documentation updates and fixes should be done via pull requests: -### Making changes +* Make sure you pull the latest version of our repository before creating a branch. Update (rebase or merge into) your PR branch to the latest before submitting a PR. Resolve all merge conflicts if any. +* In the PR, try to add a working link to your work or add screenshots if necessary. +* Build your branch locally and check every affected behavior. +## Style guide -* Whenever you are working on some major feature, always create a [new branch](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging). +We use US spelling for all our documentation and website content. Please use your IDE's spellchecker before submitting a PR. ## Build docs To build our documentation locally: -* Setup jekyll environment. See the [official documentation](https://jekyllrb.com/docs/) for guidance. -* Clone the source code from [Github](https://github.com/OpenPrinting/openprinting.github.io). +* Set up the Jekyll environment. See the [official documentation](https://jekyllrb.com/docs/) for guidance. +* Clone the source code from [GitHub](https://github.com/OpenPrinting/openprinting.github.io). * Navigate to the local repository and run: `bundle exec jekyll serve` * Open the localhost address in your web browser: `localhost:4000` From b8315234879a6f6bd036cb0f53a3b685885d68f5 Mon Sep 17 00:00:00 2001 From: Vladimir <48120135+izmalk@users.noreply.github.com> Date: Mon, 2 Feb 2026 17:24:12 +0000 Subject: [PATCH 3/4] Readability rewrite --- CONTRIBUTING.md | 89 +++++++++++++++++++++++++++---------------------- 1 file changed, 50 insertions(+), 39 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 244455dc..0d00f7b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,57 +1,68 @@ -# How to contribute +# How to Contribute -Community support is essential to making any open-source project successful. -We aim to keep contributing as simple as possible. -However, following a few guidelines shown before helps -others understand and maintain the codebase. +Thank you for your interest in contributing to OpenPrinting! Community support is essential to the success of any open-source project. We've designed our contribution process to be as straightforward as possible, and following these guidelines will help keep our codebase maintainable for everyone. -## General process +## Where Our Documentation Lives -Our documentation is published at https://openprinting.github.io/ and stored -in the [openprinting.github.io repository](https://github.com/OpenPrinting/openprinting.github.io). -All the common documentation pages are published in the -[Documentation section](https://openprinting.github.io/documentation/) and stored -in the `_documentation` directory. +Our documentation is published at https://openprinting.github.io/ and maintained in the [openprinting.github.io repository](https://github.com/OpenPrinting/openprinting.github.io). -Documentation for individual components is kept in each component’s repository, -usually in a doc directory. +**Main documentation:** -To contribute, fork the relevant repository and open a pull request with your proposed changes. -The pull request will be automatically assigned to reviewers. -Include a clear, meaningful description of what you changed and why. +- Published in the [Documentation section](https://openprinting.github.io/documentation/) +- Stored in the `_documentation` directory -If your pull request hasn’t received any review activity after a week, feel free to contact us. +**Component-specific documentation:** -## Issues workflow +- Kept in each component's own repository +- Usually located in a `doc` directory -If you spot a problem or bug, please open an issue. -Reporting and documenting issues is a valuable contribution, -even if you’re not able to fix them yourself. +## Making Changes -Use these guidelines when working with issues: +1. **Fork** the relevant repository +2. **Create a branch** from the latest version of the main branch +3. **Make your changes** with clear, focused commits +4. **Open a pull request** with a meaningful description explaining what you changed and why +5. Your PR will be automatically assigned to reviewers -* If you want to work on an issue, comment on it first to let others know you’re taking it. -* Before opening a new issue, check whether a similar issue already exists. -* For bug reports, include the browser (and version) you’re using, since behavior may differ across browsers. -* For ideas or feature requests, explain how the change will affect the user experience and/or improve the website’s functionality. +**Need help?** If your pull request hasn't received any review activity after a week, feel free to contact us. -## Pull requests +## Working with Issues -Documentation updates and fixes should be done via pull requests: +Found a bug or have an idea? Opening an issue is a valuable contribution, even if you can't fix it yourself. -* Make sure you pull the latest version of our repository before creating a branch. Update (rebase or merge into) your PR branch to the latest before submitting a PR. Resolve all merge conflicts if any. -* In the PR, try to add a working link to your work or add screenshots if necessary. -* Build your branch locally and check every affected behavior. +**Before opening an issue:** -## Style guide +- Check if a similar issue already exists -We use US spelling for all our documentation and website content. Please use your IDE's spellchecker before submitting a PR. +**When opening an issue:** -## Build docs +- For **bug reports**: Include your browser name and version, as behavior may vary across browsers +- For **feature requests**: Explain how the change will improve the user experience or website functionality -To build our documentation locally: +**Want to work on an issue?** -* Set up the Jekyll environment. See the [official documentation](https://jekyllrb.com/docs/) for guidance. -* Clone the source code from [GitHub](https://github.com/OpenPrinting/openprinting.github.io). -* Navigate to the local repository and run: `bundle exec jekyll serve` -* Open the localhost address in your web browser: `localhost:4000` +- Comment on the issue first to let others know you're working on it + +## Pull Request Guidelines + +When submitting a pull request: + +- **Stay up to date**: Pull the latest changes before creating your branch and update your PR branch before submitting +- **Resolve conflicts**: Fix any merge conflicts that arise +- **Test locally**: Build your branch and verify all affected functionality works correctly +- **Provide context**: Include a working link to your changes or add screenshots when helpful + +## Style Guide + +- Use **US spelling** for all documentation and website content +- Run your IDE's spellchecker before submitting a PR + +## Building Documentation Locally + +To preview documentation changes on your machine: + +1. **Set up Jekyll**: Follow the [official Jekyll documentation](https://jekyllrb.com/docs/) to install Jekyll +2. **Clone the repository**: `git clone https://github.com/OpenPrinting/openprinting.github.io` +3. **Navigate to the directory**: `cd openprinting.github.io` +4. **Start the server**: `bundle exec jekyll serve` +5. **View in your browser**: Open `http://localhost:4000` From 80be3539cc3aec99de3fe18d14bceca08fc80914 Mon Sep 17 00:00:00 2001 From: Vladimir <48120135+izmalk@users.noreply.github.com> Date: Mon, 2 Feb 2026 17:25:46 +0000 Subject: [PATCH 4/4] Add Markdown syntax reference --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d00f7b4..b3f60832 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,6 +55,7 @@ When submitting a pull request: ## Style Guide - Use **US spelling** for all documentation and website content +- Write documentation using **Markdown syntax** - Run your IDE's spellchecker before submitting a PR ## Building Documentation Locally