Contributing
ReqCover is developed in the open on GitHub. Contributions to the library and to this website are welcome.
- Library: github.com/reqcover/reqcover
- Website: github.com/reqcover/reqcover-website
Before you start
Section titled “Before you start”- Follow the Code of Conduct.
- Make sure that you are allowed to contribute. If you’re employed, and in doubt, check with your employer or a lawyer.
- Make sure you understand and accept the license: ReqCover is licensed under the BSD 3-Clause License.
The same guidelines are in CONTRIBUTING.md in the repository.
Contributing to ReqCover
Section titled “Contributing to ReqCover”ReqCover is a Gradle multi-module Kotlin project. The modules are reqcover-core, reqcover-engine,
reqcover-engine-junit-jupiter, reqcover-engine-testng, reqcover-engine-cucumber,
reqcover-source-openapi, reqcover-reporter-html and reqcover-reporter-xml.
You need a JDK (the CI build uses Java 21).
git clone https://github.com/reqcover/reqcover.gitcd reqcovermake # same as ./gradlew build: compiles and runs all testsOther make targets:
| Target | Action |
|---|---|
make all |
Build and test the project (default) |
make pipeline |
Run the same steps as the CI pipeline |
make version |
Print the current version |
make clean |
Remove all generated files |
make stop-gradle |
Stop the Gradle daemon |
make help |
List all targets |
How we work
Section titled “How we work”- Tests first. Write a failing test for the behavior you want, then the code that makes it pass.
Tests live in each module’s
commonTest/jvmTestsource sets. Every behavior change needs a test. - Small commits. Each commit does one thing and leaves the build green.
- Conventional Commits. Use messages like
feat(cucumber): ...,fix: ...,docs: ...,test: ...,refactor: ...,build: .... - Linear history. Rebase your branch on
trunkinstead of mergingtrunkinto it.trunkhas no merge commits. - Run
make(or./gradlew build) before opening a pull request.
Issues and pull requests
Section titled “Issues and pull requests”- Report bugs and propose features at
github.com/reqcover/reqcover/issues. Include the ReqCover version,
the test framework (JUnit, TestNG or Cucumber) and its version, the build tool, your
reqCover.*settings, and the requirement IDs involved. - Open pull requests against
trunk. CI builds and tests pull requests (changes that only touchdoc/orREADME.mdare skipped). - For security issues, do not open a public issue; see Security.
Contributing to the website
Section titled “Contributing to the website”The site is built with Astro and Starlight. You need Node.js and npm.
git clone https://github.com/reqcover/reqcover-website.gitcd reqcover-websitemake run # dev server at http://localhost:4321/| Target | Action |
|---|---|
make run |
Start the Astro dev server |
make build |
Build the production site into dist/ |
make preview |
Build, then preview the production build locally |
make check |
Type-check the Astro project |
make lint |
Run ESLint on TypeScript and Astro files |
make format |
Format code with Prettier |
Docs pages are Markdown files in src/content/docs/. Check names, settings and behavior against the
ReqCover source before documenting them. Run make build, make check and make lint before opening a
pull request against trunk.
Sponsors
Section titled “Sponsors”ReqCover is sponsored by eSol GmbH and Nelkinda Software Craft Pvt Ltd.