Skip to content

Latest commit

 

History

History
107 lines (80 loc) · 5.65 KB

CONTRIBUTING.md

File metadata and controls

107 lines (80 loc) · 5.65 KB
Raw

Guidelines for Contributing to Pbench

1. Forking the repository:

Image

Forking a repository allows you to freely experiment with changes without affecting the original project. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea.

2. Cloning

Cloning is used to create a local copy of the repository. It takes only one command in the terminal to clone the repository.

git clone https://github.com/distributed-system-analysis/pbench.git

3. Choosing an issue to work upon

  1. Go to the issues section, to find a list of open issues.

Image

  1. Select the issues you are interested to work upon based upon the labels and descriptions.

Image

  1. It is a good practice to assign the issue to yourself to let others know you're working upon it.

Image

Making changes to the codebase

  • Follow the instructions in the README.md to setup and install pbench.
  • Save your changes by creating your own local branches on git

Add, Commit and Push

  • Follow these commands to push the changes to your branch.
git add .
git commit -m "Issue solved"
git push origin branch_name

Conventions on commits, PRs, and overall git best practices.

  • Commit messages should have a short description (50 - 70 characters) followed by a longer format description of the changes below if needed. You’ll also notice each line is formatted for a specific length in the longer format description. For example:
Extend auditing to incoming, results, and users

The server audit is now applied to the incoming, results, and users
directory hierarchies.  Any unpacked tar ball should now be compre-
hensively checked to see that all is in the correct place.

The test-20 unit test gold file holds an example of an audit report
covering all the possible outputs it can emit.  Each unit test runs
the report as well, and they have been updated accordingly.

Opening a pull request

  1. If there are multiple commits, squash down the commits to one

  2. For more complicated commits it is appropriate to have more than one

  3. Commit the changes

  4. Click on New Pull Request

  5. Write appropriate Pull Request Title stating the fix

  6. Use present tense (ex. Fixes, Changes, Fixing, Changing..)

  7. Reference the issue that the PR is fixing with “Fixes #issue_number” in the description

  8. Provide a detailed description of the changes; if UI related, add screenshots

  9. Make sure that the branches can be automatically merged (otherwise rebase the PR with master) and then click the drop down next to, Create pull request, and select Create draft pull request Image

  10. Assign the PR to yourself and add appropriate labels

  11. Add "DO NOT MERGE" label if the work does not need to be merged or there is no agreement on the work yet

  12. Make sure to add Milestone to the PR to mention specific release

  13. Request for review once the work is ready for getting reviewed Image

  14. Select the Ready for Review button to move the PR out of Draft mode indicating it is ready for review and merging

Creating an Isssue

  1. Make sure to add proper details to the Issue raised
  2. Upload screenshot(if possible) in dashboard issues
  3. Apply proper labels to the Issue
  4. Try to actively respond to the communication in case of comments in the same issue.

Reviewing a pull request

  1. Go to Files changed and check for the fixes proposed by the Pull Request
  2. Check for certain general criteria:
  3. The PR has no merge conflicts with the base branch
  4. The commits are squashed into one
  5. There is proper indentation and alignment
  6. No additional lines are added unnecessarily
  7. The code is clearly understandable, with comments if necessary to clarify
  8. Do not merge the PR with DO NOT MERGE or WIP label.
  9. In case of the requirement of running the changes in the PR on the local system, follow the mentioned process:
  • To fetch a remote PR into your local repo,
git fetch origin pull/ID/head:BRANCHNAME
where ID is the pull request id and BRANCHNAME is the name of the new branch that you want to create. Once you have created the branch, then simply
git checkout BRANCHNAME