This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 1e397eee00f (chores) doc: minor contributions clarifications
1e397eee00f is described below
commit 1e397eee00f7c859d2cb0dff268cba8066b372ba
Author: Otavio R. Piske <angusyo...@gmail.com>
AuthorDate: Sat Feb 10 11:27:32 2024 +0100
(chores) doc: minor contributions clarifications
- about build changes
- about missing assertions
Signed-off-by: Otavio R. Piske <angusyo...@gmail.com>
---
docs/main/modules/contributing/pages/index.adoc | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/docs/main/modules/contributing/pages/index.adoc
b/docs/main/modules/contributing/pages/index.adoc
index 6b5740b434d..fb6deb5c913 100644
--- a/docs/main/modules/contributing/pages/index.adoc
+++ b/docs/main/modules/contributing/pages/index.adoc
@@ -237,8 +237,11 @@ CAMEL-9999: Some message goes here
=== Making a good contribution
+* Less is more:
+** Avoid creating unnecessary Maven profiles (i.e.; to enable/disable tests)
+** Avoid creating custom surefire/failsafe configurations (use defaults as
much as possible)
* Ensure that the unit tests include proper assertions.
-* Avoid simply outputting changes to the standard output/error or just logging.
+* Avoid simply outputting changes to the standard output/error or just logging
(tests **must** have assertions).
* Please also avoid unnecessary changes, like reordering methods and fields,
which will make your PR harder to review.
* When submitting a performance improvement, providing JMH test data as
evidence or adding a JMH-based test on the
https://github.com/apache/camel-performance-tests/[camel-performance-tests]
repository is strongly recommended.
* Be responsive, assume good intent and respect the
https://www.apache.org/foundation/policies/conduct.html[Code of Conduct]
