Skip to content

Latest commit

 

History

History
128 lines (79 loc) · 5.05 KB

CONTRIBUTING.md

File metadata and controls

128 lines (79 loc) · 5.05 KB
Raw

Roaster Contributing Guide

Basic Steps

To contribute to Roaster, fork the core repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.

If you don't have the Git client (git), get it from: http://git-scm.com/

Here are the steps in detail:

  1. Fork the project. This creates a the project in your own Git with the default remote name 'origin'.

  2. Clone your fork. This creates and populates a directory in your local file system.

     git clone git@github.com:<your-username>/roaster.git

  3. Add the remote upstream repository so you can fetch any changes to the original forked repository.

     git remote add upstream git@github.com:forge/roaster.git

  4. Get the latest files from the upstream repository.

     git fetch upstream

  5. Create a new topic branch to contain your features, changes, or fixes using the git checkout -b <topic-branch-name> upstream/master command. For example:

     git checkout -b ROASTER-123 upstream/master

  6. Contribute new code or make changes to existing files. If you're using Eclipse, be sure to format your code using the provided Forge Code Formatter ). If you're using IntelliJ IDEA, we recommend using this plugin to use the before-mentioned Eclipse code formatter in IDEA.

  7. Use the git add command to add new or changed file contents to the staging area. git add .

  8. Use the git status command to view the status of the files in the directory and in the staging area and ensure that all modified files are properly staged:

     git status

  9. Commit your changes to your local topic branch.

     git commit -m 'ROASTER-XX: Description of change...'

  10. If you made multiple commits, or if there were any merge commits created when you pulled from upstream, use rebase to squash them into a single commit, where 5 is the number of commits to rebase:

    git rebase -i HEAD~5

    Change 'pick' to 'f' for each commit you wish to fixup upwards. (If you do not change a line, it will not be modified.)

    1 pick ade2b1a ROASTER-XX: Implemented XYZ
2 f c3ae0a2 almost done
3 f c863bfb did more work
4 f af793ae Started working on FORGE-XX
5 pick 368bbb9 Previous commit written by someone else

    Once you are done, your commits should look like this:

    1 ade2b1a ROASTER-XX: Implemented XYZ
2 368bbb9 Previous commit written by someone else

    You can view your commits by typing:

    git log

  11. Push your local topic branch to your github forked repository. This will create a branch on your Git fork repository with the same name as your local topic branch name.

    git push origin HEAD

Note: The above command assumes your remote repository is named 'origin'. You can verify your forked remote repository name using the command git remote -v.

  1. Browse to the branch on your forked Git repository and open a Pull Request. Give it a clear title and description.

Choosing issues to work on

If you're wondering what issues would be suitable when you're just getting started, we recommend taking a look at the issues with the 'starter' label in our JIRA.

License Information and Contributor Agreement

Roaster is licensed under the Eclipse Public License 1.0.

There is no need to sign a contributor agreement to contribute to Roaster. You just need to explicitly license any contribution under the EPL 1.0. If you add any new files to Roaster, make sure to add the correct header.

Java, Javascript and CSS files

  /**
   * Copyright 2015 Red Hat, Inc. and/or its affiliates.
   *
   * Licensed under the Eclipse Public License version 1.0, available at
   * http://www.eclipse.org/legal/epl-v10.html
   */

HTML, XML, XSD and XHTML files

  <!--
   ~ Copyright 2015 Red Hat, Inc. and/or its affiliates.
   ~
   ~ Licensed under the Eclipse Public License version 1.0, available at
   ~ http://www.eclipse.org/legal/epl-v10.html
  -->

Properties files and Bash Scripts

   # Copyright 2015 Red Hat, Inc. and/or its affiliates.
   #
   # Licensed under the Eclipse Public License version 1.0, available at
   # http://www.eclipse.org/legal/epl-v10.html

SQL files

  --
  -- Copyright 2015 Red Hat, Inc. and/or its affiliates.
  --
  -- Licensed under the Eclipse Public License version 1.0, available at
  -- http://www.eclipse.org/legal/epl-v10.html
  --

JSP files

  <%--
  Copyright 2015 Red Hat, Inc. and/or its affiliates.

  Licensed under the Eclipse Public License version 1.0, available at
  http://www.eclipse.org/legal/epl-v10.html
  --%>