[smart-load-test commit] r159 - wiki
codesite...@google.com
Date: Wed Nov 12 00:48:57 2008
New Revision: 159
Added:
wiki/Contributors.wiki
Log:
Created wiki page through web user interface.
Added: wiki/Contributors.wiki
==============================================================================
--- (empty file)
+++ wiki/Contributors.wiki Wed Nov 12 00:48:57 2008
@@ -0,0 +1,35 @@
+#summary How to contribute to the project
+
+= Introduction =
+
+Firstly, this project is open to contributors and thus we are using
distributed SCM (git) so that it becomes easier for people to contribute.
There are several ways one can contribute to the project, such as
submitting patches, reporting issues, providing test cases, writing
documentation and any other way you can figure out that you can contribute
to the project.
+
+
+= Details =
+
+We will discuss the how-to details of how to contribute to the project as
follows.
+
+==Submitting Patches==
+
+Basically we will accept patches generated by git. Until this project is
release I guess we will have to accept patches through attachment either to
an issue or in an email to the developer mailing list. If you are wondering
how to create patches please consider
[http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html this
page]. IMHO, when you start commits for contribution do create a
topic-branch (normal git branch) and make all your change on that branch
once you are done create patch series using the following command -
+{{{
+git format-patch -M -B origin/master
+}}}
+Assumption for the above command is that you have added the project
[SourceCode repo] as origin. You might also consider
using '--find-copies-harder' if renaming/relocating binary files and/or
using '--output-directory' for specifying where to create the patch files.
If you want to send patches for review (which is the preferable way to
start contributing) please use try and use
[http://www.kernel.org/pub/software/scm/git/docs/git-send-email.html git
send-email], please
[http://git.or.cz/gitwiki/GitTips#head-a015948617d9becbdc9836776f96ad244ba87cb8
check here] for configuring it to use your gmail account.
+
+Contributors willing to enrich the poor documentation please feel free to
start equivalent discussion in the developers list.
+
+==Reporting Issues==
+
+A great way to contribute to the project is by reporting issues, either
defect or improvement. When reporting a defect/bug we would be grateful if
you would be kind enough to follow the guideline mentioned as follows:
+ * First produce it several times locally.
+ * Create a issue in the
[http://code.google.com/p/smart-load-test/issues/list issue tracker].
+ * Please remember to mention the steps properly to create the problem
+ * If the problem is with the API please provide code that produces the
bug
+ * Feel free to add screen shots and other attachments that would
clarify the issue.
+ * Report the issue to the developers list.
+We can ensure that someone will take a look at the issue ASAP and contact
you.
+
+==Participation==
+
+You could also help us by providing your useful suggestions on how we can
improve. You could also be a great contributor to the project by helping
others to get involved and used-to to the project.
\ No newline at end of file