This is an automated email from the ASF dual-hosted git repository. fschumacher pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/jmeter.git
commit ff6beec30a6b25945192006a94a0a420118f4ad7 Author: Felix Schumacher <[email protected]> AuthorDate: Sat Aug 3 12:39:04 2019 +0200 Markup and one missing gradle conversion Remove question marks on header lines to comply with best practices for markdown. Use clearer text for long links to comply with best practices for markdown and html in general. A bit of whitespace police. One left over 'ant test' to './gradlew check' conversion --- CONTRIBUTING.md | 51 +++++++++++++++++++++++++++------------------------ 1 file changed, 27 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb8ab6a..7f2995f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,26 +2,27 @@ Want to show Apache JMeter some love? Help out by contributing! -## :beetle: Found a bug? +## :beetle: Found a bug Log it in our bugzilla: -* *https://jmeter.apache.org/issues.html* -* or send a note to the *user mailing list*. -Be sure to include all relevant information, like the versions of JMeter you’re using as long as Java version. +* *https://jmeter.apache.org/issues.html* +* or send a note to the *user mailing list*. +Be sure to include all relevant information, like the versions of JMeter you’re using as long as Java version. A Test plan that caused the issue as well as any error messages are also very helpful. -## :question: Need help? +## :question: Need help + Simply contact: -* our user mailing list *https://jmeter.apache.org/mail2.html#JMeterUser* +* [Our users mailing list](https://jmeter.apache.org/mail2.html#JMeterUser) * or ask question on [stackoverflow](https://stackoverflow.com/questions/tagged/jmeter). -## :bar_chart: What needs to be developed? +## :bar_chart: What needs to be developed See: -* https://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Blocker&bug_severity=Critical&bug_severity=Major&bug_severity=Normal&bug_severity=Regression&bug_severity=Minor&bug_severity=Trivial&product=JMeter&order=Bug%20Number&list_id=164231 -* https://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Enhancement&product=JMeter&order=Bug%20Number&list_id=164232 +* [Open bug entries for JMeter](https://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Blocker&bug_severity=Critical&bug_severity=Major&bug_severity=Normal&bug_severity=Regression&bug_severity=Minor&bug_severity=Trivial&product=JMeter&order=Bug%20Number&list_id=164231) +* [Enhancement requests for JMeter](https://bz.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_severity=Enhancement&product=JMeter&order=Bug%20Number&list_id=164232) ## Development setup @@ -58,9 +59,10 @@ The steps to import the sources (based on Eclipse 2019-06) into Eclipse are as f 1. Read `How to experience the best Gradle integration` and click `Next` 1. Then you might just click `Finish` -## :star2: Have a patch? +## :star2: Have a patch + The best way to make sure your issue or feature is addressed is to submit a patch. -We accept patches through: +We accept patches through: * pull requests * patch attached to bugzilla. @@ -70,26 +72,27 @@ However, before sending a patch, please make sure that the following applies: * Your commit message is descriptive. * Your patch doesn't have useless merge commits. * Your coding style is similar to ours. -* Your patch is 100% tested. JUnit are welcome. -* All tests checks pass (run `ant test`) +* Your patch is 100% tested. JUnit are welcome. +* All tests checks pass (run `./gradlew check`) * You understand that we're very grateful for your patch! -## :heart: Adding something new? -We do love to enhance Apache JMeter with you to become more powerful! +## :heart: Adding something new + +We do love to enhance Apache JMeter with you to become more powerful! The best way to workout your idea is to discuss it first at our dev mailing list: -* https://jmeter.apache.org/mail2.html#JMeterDev +* [JMeter developers mailing list](https://jmeter.apache.org/mail2.html#JMeterDev) -Please, if you can, don't just throw us the code of a new feature; lets figure first together -what would be the best approach regarding the current architecture and future plans, -before any development. -This way we all get sure that your idea is aligned with the codebase and you can enjoy +Please, if you can, don't just throw us the code of a new feature; lets figure first together +what would be the best approach regarding the current architecture and future plans, +before any development. +This way we all get sure that your idea is aligned with the codebase and you can enjoy your happy coding even more :) -## :closed_book: Want to write docs? +## :closed_book: Want to write docs -Documentation is very valuable to us. +Documentation is very valuable to us. -It is located in **xdocs** folder in XML format. +It is located in **[xdocs](xdocs)** folder in XML format. -You can contribute as you would for code through patch or PR. +You can contribute as you would for code through patch or *PR* (pull request).
