From commits-return-8097-apmail-jmeter-commits-archive=jmeter.apache.org@jmeter.apache.org Wed Nov 8 12:55:01 2017 Return-Path: X-Original-To: apmail-jmeter-commits-archive@minotaur.apache.org Delivered-To: apmail-jmeter-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id BB77810B86 for ; Wed, 8 Nov 2017 12:55:01 +0000 (UTC) Received: (qmail 71599 invoked by uid 500); 8 Nov 2017 12:55:01 -0000 Delivered-To: apmail-jmeter-commits-archive@jmeter.apache.org Received: (qmail 71559 invoked by uid 500); 8 Nov 2017 12:55:01 -0000 Mailing-List: contact commits-help@jmeter.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jmeter.apache.org Delivered-To: mailing list commits@jmeter.apache.org Received: (qmail 71544 invoked by uid 99); 8 Nov 2017 12:55:01 -0000 Received: from Unknown (HELO svn01-us-west.apache.org) (209.188.14.144) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 08 Nov 2017 12:55:01 +0000 Received: from svn01-us-west.apache.org (localhost [127.0.0.1]) by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org) with ESMTP id B520D3A028F for ; Wed, 8 Nov 2017 12:55:00 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: svn commit: r1814573 - /jmeter/trunk/CONTRIBUTING.md Date: Wed, 08 Nov 2017 12:55:00 -0000 To: commits@jmeter.apache.org From: pmouawad@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20171108125500.B520D3A028F@svn01-us-west.apache.org> Author: pmouawad Date: Wed Nov 8 12:55:00 2017 New Revision: 1814573 URL: http://svn.apache.org/viewvc?rev=1814573&view=rev Log: Add github Contributing guidelines Added: jmeter/trunk/CONTRIBUTING.md Added: jmeter/trunk/CONTRIBUTING.md URL: http://svn.apache.org/viewvc/jmeter/trunk/CONTRIBUTING.md?rev=1814573&view=auto ============================================================================== --- jmeter/trunk/CONTRIBUTING.md (added) +++ jmeter/trunk/CONTRIBUTING.md Wed Nov 8 12:55:00 2017 @@ -0,0 +1,60 @@ +# How to contribute + +Want to show Apache JMeter some love? Help out by contributing! + +## :beetle: Found a bug? +Log it in our bugzilla: + +* *http://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? +Simply contact: + +* our user mailing list *http://jmeter.apache.org/mail2.html#JMeterUser* +* or ask question on [stackoverflow](https://stackoverflow.com/questions/tagged/jmeter). + +## :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 + +## :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: + +* pull requests +* patch attached to bugzilla. + +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`) +* 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! +The best way to workout your idea is to discuss it first at our dev mailing list: + +* http://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 +your happy coding even more :) + +## :closed_book: Want to write docs? + +Documentation is very valuable to us. + +It is located in **xdocs** folder in XML format. + +You can contribute as you would for code through patch or PR.