Skip to content

Commit

Permalink
[issue-223] - Update project high-level doc structure, improve testsu…
Browse files Browse the repository at this point in the history
…ite execution documentation and contributing guidelines
  • Loading branch information
fabiobrz committed Jan 14, 2025
1 parent e0106f3 commit 7359be2
Show file tree
Hide file tree
Showing 3 changed files with 125 additions and 94 deletions.
27 changes: 17 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,27 @@

Thank you for contributing to [Intersmash](https://github.com/Intersmash/intersmash)!

Try to follow used patterns and submit a clean PR that fix ideally one issue.
A new unit test has to be part of the PR in case the change is related to a shared code base.
When submitting changes, try to follow used patterns and prepare a clean PR that should ideally fix one issue.
A new unit test _should_ to be part of the PR in case the changes are related to a common code base.

## Adding code

To include new code into this project please open a pull request against the `main` branch by referencing the
issue that tracks the work.
To contribute changes to Intersmash please open a pull request against the `main` branch by referencing the
issue that tracks the work.

### Adding tooling code
As said, the changes must be tracked by a [GitHub issue](https://github.com/Intersmash/intersmash/issues), so feel free to open one to manage Intersmash
feature requests, requests for enhancements and bugs.

- The changes must be tracked by a [GitHub issue](https://github.com/Intersmash/intersmash/issues)
so open one to manage Intersmash feature requests, requests for enhancements and bugs.
- Open a PR referencing the GitHub issue, e.g.: _[issue 9] - Reorgaanize project docs_
Once you're satisfied with your changes, push them by opening a PR referencing the GitHub issue, e.g.:
_"\[issue 9\] - Reorgaanize project docs"_.
Commit messages should include the issue tracker to, e.g.: _"\[issue-218\] - Update supported Kafka"_

Once pushed, automatic CI checks will be run to test the changes, and reported on the GitHub pull request, see e.g.:
https://github.com/Intersmash/intersmash/pull/220/checks.
Once those are green, one project maintainer should start OpenShift tests, which are run on internal infrastructure.
The validation job outcome will be reported as a comment to the PR, see e.g.: https://github.com/Intersmash/intersmash/pull/220#issuecomment-2589828030.
Project maintainers will look into the failures and provide with further details until OpenShift tests are deemed to
be passing.

#### Creating an issue

Expand All @@ -32,5 +40,4 @@ to format your code before sending it for revision.
CI jobs will run the checks (`mvn formatter:validate impsort:check`) and fail in case of wrong formatting.

To set up your IDE to comply with the formatting, please get the
[eclipse-format.xml](./ide-config/eclipse-format.xml) configuration file and follow
[Eclipse Code Formatter instructions](https://github.com/krasa/EclipseCodeFormatter#instructions).
[eclipse-format.xml](./ide-config/eclipse-format.xml) configuration file and follow [Eclipse Code Formatter instructions](https://github.com/krasa/EclipseCodeFormatter#instructions).
Loading

0 comments on commit 7359be2

Please sign in to comment.