Skip to content

Commit 409c393

Browse files
committed
docs: update links and improve wording in documentation
1 parent d0e8a50 commit 409c393

File tree

3 files changed

+13
-15
lines changed

3 files changed

+13
-15
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Code of Conduct - robotcode
1+
# Code of Conduct - RobotCode
22

33
## Our Pledge
44

CONTRIBUTING.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ And if you like the project, but just don't have time to contribute, that's fine
3939
## Code of Conduct
4040

4141
This project and everyone participating in it is governed by the
42-
[robotcode Code of Conduct](https://github.com/robotcodedev/robotcode/blob/master/CODE_OF_CONDUCT.md).
42+
[robotcode Code of Conduct](https://github.com/robotcodedev/robotcode/blob/main/CODE_OF_CONDUCT.md).
4343
By participating, you are expected to uphold this code. Please report unacceptable behavior
4444
4545

@@ -186,8 +186,8 @@ For local development with containers:
186186
If you prefer to set up locally:
187187

188188
1. **Prerequisites:**
189-
- Python 3.8+ (system Python is fine)
190-
- Node.js 16+
189+
- Python 3.10+ (system Python is fine)
190+
- Node.js 22+
191191
- Git
192192

193193
2. **Setup:**
@@ -249,6 +249,8 @@ You can also check available environments with: `hatch env show`
249249
6. **Commit your changes** with a descriptive commit message
250250
7. **Push and create a pull request**
251251

252+
Note on Python versions: while the project tests across Python 3.8–3.13 to ensure broad compatibility, active development and production usage target Python 3.10+.
253+
252254
#### Pull Request Guidelines
253255

254256
Before submitting your pull request:
@@ -561,7 +563,3 @@ If you're interested in joining the project team:
561563
- **Alignment** with project goals and values
562564

563565
We value diversity and welcome contributors from all backgrounds. The robotcode project benefits from different perspectives and experiences.
564-
565-
<!-- omit in toc -->
566-
## Attribution
567-
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# RobotCode - The Ultimate Robot Framework Toolset
22

3-
[![License](https://img.shields.io/github/license/robotcodedev/robotcode?style=flat&logo=apache)](https://github.com/robotcodedev/robotcode/blob/master/LICENSE)
3+
[![License](https://img.shields.io/github/license/robotcodedev/robotcode?style=flat&logo=apache)](https://github.com/robotcodedev/robotcode/blob/main/LICENSE)
44
[![Build Status](https://img.shields.io/github/actions/workflow/status/robotcodedev/robotcode/build-test-package-publish.yml?branch=main&style=flat&logo=github)](https://github.com/robotcodedev/robotcode/actions?query=workflow:build_test_package_publish)
55
[![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/d-biehl.robotcode?style=flat&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
66
[![Installs](https://img.shields.io/visual-studio-marketplace/i/d-biehl.robotcode?style=flat)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
7-
[![JETBRAINS Marketplace](https://img.shields.io/jetbrains/plugin/v/26216.svg)](https://plugins.jetbrains.com/plugin/26216)
7+
[![JetBrains Marketplace](https://img.shields.io/jetbrains/plugin/v/26216.svg)](https://plugins.jetbrains.com/plugin/26216)
88
[![Downloads](https://img.shields.io/jetbrains/plugin/d/26216.svg)](https://plugins.jetbrains.com/plugin/26216)
99
[![PyPI - Version](https://img.shields.io/pypi/v/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
1010
[![Python Version](https://img.shields.io/pypi/pyversions/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
@@ -60,7 +60,7 @@ With RobotCode, you can focus on building and testing your automation workflows
6060

6161
### IDE Support
6262

63-
- Visual Studio Code 1.99 or newer
63+
- Visual Studio Code 1.99.0 or newer
6464
- PyCharm 2025.1 or newer or IntelliJ IDEA 2025.1 or newer
6565

6666
### Deprecated Python and Robot Framework Versions
@@ -111,7 +111,7 @@ To get the most out of RobotCode, we recommend using:
111111
Visit the [Getting Started Guide](https://robotcode.io/02_get_started/) for detailed setup instructions and advanced features.
112112

113113
**Extensions:**
114-
RobotCode automatically installs the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) and the [Python Debugger](https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy) extension. Additional extensions may be required depending on your project needs.
114+
RobotCode declares dependencies on the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) and [Python Debugger](https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy) extensions so VS Code installs them when required. Additional extensions may be needed depending on your project.
115115

116116

117117
### IntelliJ IDEA or PyCharm
@@ -140,7 +140,7 @@ RobotCode automatically installs the [Python](https://marketplace.visualstudio.c
140140
Visit the [Getting Started Guide](https://robotcode.io/02_get_started/) for detailed setup instructions and advanced features.
141141

142142
**Plugins:**
143-
RobotCode automatically installs the [LSP4IJ](https://plugins.jetbrains.com/plugin/23257). Additional plugins may be required depending on your project needs.
143+
RobotCode declares a dependency on [LSP4IJ](https://plugins.jetbrains.com/plugin/23257) so your IDE installs it automatically. Additional plugins may be required depending on your project needs.
144144

145145

146146
## Documentation
@@ -157,7 +157,7 @@ Here are some additional resources to help you troubleshoot or learn more:
157157

158158
## Support RobotCode
159159

160-
RobotCode is developed and maintained by volunteers. Your support helps us continue improving and adding new features.
160+
RobotCode is driven by the passion of its lead developer and the support of a growing community. To continue adding new features, improving stability, and expanding the ecosystem, your involvement is essential. Whether you contribute code, offer feedback, or provide financial support, you help shape the future of RobotCode.
161161

162162
**Become a Sponsor:**
163163
- [GitHub Sponsors](https://github.com/sponsors/robotcodedev) - Monthly or one-time sponsorship
@@ -189,4 +189,4 @@ This project is licensed under the [Apache 2.0 License](https://spdx.org/license
189189
[Robot Framework Foundation](https://robotframework.org/foundation)
190190

191191

192-
[Jetbrains](https://jb.gg/OpenSourceSupport)
192+
[JetBrains](https://jb.gg/OpenSourceSupport)

0 commit comments

Comments
 (0)