community.html.haml

---
layout: default
---
%header
  .row
    .col-lg-6.jumbo
      %h1
        %i.fa.fa-group
        Community
      %p.lead We love contributors!
    .col-lg-6
      .well{:style => "padding: 25px 25px 15px 25px;"}
        %span{:style => "display: block; font-weight: bold; margin-bottom: 1em;"} Welcome to the PerfCake community!
        %span{:style => "display: block;"} Please dive in wherever takes your fancy! We would like to make your contributions a piece of cake.
        %a.pull-right.btn.btn-primary.btn-big{:href => "#contribution"}
          %i.fa.fa-question-circle-o.icon-white
          How To Contribute »
        %div{:style => "clear:both"}

.row
  .col-lg-6
    %h3
      %i.fa.fa-bug
      Issue tracker
    %p
      The project tracks bugs, feature requests, and other issues through the Github issue tracking system.
    %p
      %a.btn.btn-primary.btn-big{:href => "https://github.com/PerfCake/PerfCake/issues", :target => "_blank"}
        %i.fa.fa-info-circle.icon-white
        PerfCake Issue Tracker »
    %h3
      %i.fa.fa-comments
      Chat (IRC)
    %p
      We invite you to join us in the
      %strong #perfcake
      channel on
      %strong irc.freenode.net
      to chat about PerfCake.
  .col-lg-6
    %h3
      %i.fa.fa-github-alt
      Source Repository
    %p
      Both git and Github are awesome for collaboration! To make improvements or bug fixes to the PerfCake project, simply fork the project, commit your changes, and send a pull request.
      %a{:name => "contribution"}
    %p
      %a.btn.btn-primary.btn-big{ :href => 'https://github.com/PerfCake/PerfCake', :target => '_blank' }
        %i.fa.fa-info-circle.icon-white
        PerfCake sources at GitHub »
    %h3
      %i.fa.fa-google-plus
      Google Group
    %p
      Mainly for design discussions and a community level support we have a forum group at Google.
    %p
      %a.btn.btn-primary.btn-big{:href => "https://groups.google.com/forum/#!forum/perfcake", :target => "_blank"}
        %i.fa.fa-info-circle.icon-white
        PerfCake Google Group »

.row
  .col-lg-12
    %section#contribution
      %h2
        How to contribute
      %p
        We love contributions! We really need your help to make
        %a{:href => "http://www.perfcake.org"} PerfCake
        even more a piece of cake, so please join our community!
      %p
        Many thanks to all of our
        = succeed "!" do
          %a{:href => "https://github.com/PerfCake/PerfCake/graphs/contributors", :target => '_blank'} existing contributors
        But we're greedy, we want more! PerfCake is great, but it can be better! :). We have lots of extensions, generators, senders, validators, reporters... that can be improved and we want more of them!
      %p Here's some notes to help you get started:

      %h3 Getting Started
      %ul
        %li
          Make sure you have a
          %a{:href => "https://github.com/signup/free", :target => '_blank'} GitHub account
          as you'll need it to submit issues, comments or pull requests.
        %li
          Got any ideas for how we can improve PerfCake? Please
          %a{:href => "https://github.com/PerfCake/PerfCake/issues?state=open", :target => '_blank'} submit an issue
          with your thoughts. Constructive criticism is always greatly appreciated!
        %li
          Fancy submitting any
          = succeed "?" do
            %a{:href => "http://perfcake.blogspot.com", :target => '_blank'} nice story of how you're using PerfCake
          A quick Youtube screencast would be even better or a blog post/article we can link to? Just
          %a{:href => "https://github.com/PerfCake/PerfCake/issues?state=open", :target => '_blank'} submit an issue
          (or fork and patch the
          = succeed ")" do
            %a{:href => "https://github.com/PerfCake/Web", :target => '_blank'} website
          and we'll merge it into our website.
        %li
          Search
          %a{:href => "https://github.com/PerfCake/PerfCake/issues?state=open", :target => '_blank'} our issue tracker
          and see if there's been any ideas or issues reported for what you had in mind; if so please join the conversation in the comments.
        %li
          Submit any issues, feature requests or improvement ideas to
          = succeed "." do
            %a{:href => "https://github.com/PerfCake/PerfCake/issues?state=open", :target => '_blank'} our issue tracker
        %ul
          %li Clearly describe the issue including steps to reproduce when it is a bug.
          %li Make sure you fill in the earliest version that you know has the issue.

      %h3
        Fancy hacking some code?
        %span.label.label-success cake
      %ul
        %li If you fancy working on some code, check out these lists of issues:
        %ul
          %li
            %a{:href => "https://github.com/PerfCake/PerfCake/issues?labels=cake&page=1&sort=updated&state=open", :target => '_blank'} cakes
            \- which are moderately easy to fix and tend to have links to which bits of the code to look at to fix at
          %li
            %a{:href => "https://github.com/PerfCake/PerfCake/issues?labels=help+needed&page=1&sort=updated&state=open", :target => '_blank'} help needed
            \- projects with a span in the range from several days to several weeks, which are suitable for a thesis or a project work or simply when you want to contribute a limited well defined amount of work
          %li
            %a{:href => "https://github.com/PerfCake/PerfCake/issues?state=open", :target => '_blank'} all open issues
            \- if you fancy being more adventurous.
          %li
            %a{:href => "https://github.com/PerfCake/PerfCake/issues?labels=enhancement&page=1&sort=updated&state=open", :target => '_blank'} enhancements
            \- if you're feeling like a ninja and fancy tackling our harder issues that tend to add really cool new features!
        %li
          To make code changes, fork the
          %a{:href => "https://github.com/PerfCake/PerfCake", :target => '_blank'} repository on GitHub
          and then you can hack on the code. We love any contribution such as:
        %ul
          %li fixing typos
          %li improving the documentation or embedded help
          %li writing new test cases or improve existing ones
          %li adding new features

      %h3 Submitting changes to PerfCake
      %ul
        %li
          Push your changes to your fork of the
          = succeed "." do
            %a{:href => "https://github.com/PerfCake/PerfCake", :target => '_blank'} PerfCake repository
        %li Submit a pull request to the repository in the PerfCake organization.
        %li If your change references an existing issue then use “fixes #123” in the commit message (using the correct issue number).
        %li
          Your work will be reviewed by one of the developers who do not have any mercy. So for your pull request to be accepted make sure to
          %ul
            %li Develop tests for your features/fixes (keep the high level of test coverage),
            %li
              Use the appropriate code style and formatting (
              %a{ :href => 'https://github.com/PerfCake/PerfCake/blob/master/code-formating/perfcake-java-profile.xml', :target => '_blank' } Eclipse configuration file
              is present in the repo),
            %li
              Avoid introducing new FindBugs warnings
              (see
              %a{ :href => "#{site.base_url}/guide/devel" } Developers' Guide
              to find out how to generate the site report),
            %li Keep backward compatibility unless previously discussed with the developers,
            %li Write/update the JavaDoc comments,
            %li You do not keep unused imports, FIXME comments, unused variables, cryptic code or anything ugly,
            %li Submit only a masterpiece code that you could be proud of.

      %h3 Additional Resources
      %ul
        %li
          %a{:href => "http://help.github.com/", :target => '_blank'} General GitHub documentation
        %li
          %a{:href => "https://help.github.com/articles/creating-a-pull-request", :target => '_blank'} GitHub create pull request documentation
        %li
          %a{:href => "#{site.base_url}/docs/developers-guide/dev.contributor.developing.html#dev.contributor.developing.building"} Here is how to build the code