You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@ You can check more complete and complex diagrams [here](docs/diagrams).
55
55
56
56
Here we will detail the main steps and things to take into consideration when implementing a new test element, or extending an existing one.
57
57
58
-
Before doing any coding, consider that the project uses Java 8, maven 3.5, and docker as main dependencies, so make sure that you install them beforehand.
58
+
Before doing any coding, consider that the project uses Java 8, maven 3.5, nodejs 18+, pnpm 8+, and docker as main dependencies, so make sure that you install them beforehand. You might also install [devbox](https://www.jetpack.io/devbox/docs/) and [direnv](https://direnv.net/) and then use existing devbox configuration to setup the development environment.
59
59
60
60
Additionally, the project uses checkstyle for enforcing code consistency and conventions. You can get IDEs settings from [here](https://github.com/google/styleguide), which already matches the code style rules. Using IDEs autoformatting with such configurations should automatically fix most styling issues.
61
61
@@ -129,7 +129,7 @@ Additionally, the project uses checkstyle for enforcing code consistency and con
129
129
* In MethodCallBuilderTest defined tests you should not use methods for abstracting duplicate logic between tests (nor variables or constants for literals). Code duplication in this case is acceptable and expected.
130
130
* Check [DslTestPlanTest](jmeter-java-dsl/src/test/java/us/abstracta/jmeter/javadsl/core/DslTestPlanTest.java) for some tests examples.
131
131
8. Run `mvn clean package` and fix any potential code styling issues or failing tests.
132
-
9. Add a new section [user guide](docs/guide), by adding a new md file and proper `@include` in parent section, describing the new feature. Consider running in the `docs` directory `yarn install` and `yarn dev` (this requires node 14 and yarn installed on your machine) to run a local server for docs, where you can review that new changes are properly showing.
132
+
9. Add a new section [user guide](docs/guide), by adding a new md file and proper `@include` in parent section, describing the new feature. Consider running in the `docs` directory `pnpm install` and `pnpm dev` (this requires node 18+ and pnpm installed on your machine) to run a local server for docs, where you can review that new changes are properly showing. If you use devbox then you can use `devbox run setup` and `devbox run docs`.
133
133
10. Commit changes to git, using as a comment a subject line that describes general changes, and if necessary, some additional details describing the reason why the change is necessary.
134
134
11. Submit a pull request to the repository including a meaningful name.
135
135
12. Check GitHub Actions execution to verify that no test fails on the CI pipeline.
0 commit comments