Skip to content

Latest commit

 

History

History
104 lines (78 loc) · 5.48 KB

CONTRIBUTING.md

File metadata and controls

104 lines (78 loc) · 5.48 KB
Raw

How to contribute

Community contributions are essential part of any open source project. The community has access to a large number of unique configurations which would be extremely difficult for the core maintainers to reproduce. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Getting Started

  • Make sure you have a GitHub account
  • Submit a ticket for your issue, assuming one does not already exist. If you have the rights, you should assign yourself to the issue and click 'start progress' to indicate that the issue is underway. If you do not have that ability please add a comment noting that a pull request will be submitted for the issue, and the engineering team will handle the assignment. After review, if the pull request is accepted, we will mark the issue as resolved and assign it to a release so it can be QA'ed.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
    • We have included an issue template which helps make sure all of the relevant information is included with the issue report.

Fork the repository on GitHub

If this is your first time working with Dnn:Platform. You will need to fork the repository to get your system configured for local development.

  • Click fork on the main Dnn:Platform project
  • Clone your fork locally with git clone https://github.com/[username]/Dnn.Platform.git replacing [username] with your account information.
  • Add the upstream connection so you can rebase and update your fork with git remote add upstream https://github.com/dnnsoftware/Dnn.Platform.git
    • To update your fork to the latest, you can then run git fetch upstream followed by git push

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the 'development' branch.
    • Release branches should only be targeted by official committers.
    • To quickly create a topic branch based on development; git checkout -b my_contribution development
  • Make commits of logical units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • When ready to publish your changes, you can with git push -u origin my_contribution
  • Make sure your pull request description tags the GitHub issue ID, so it is clear what issue you have fixed.
  • Make sure your commit messages are in the proper format.
    Short (72 chars or less) summary.

    More detailed explanatory text. Wrap it to 72 characters. The blank
    line separating the summary from the body is critical (unless you omit
    the body entirely).

    Write your commit message in the imperative: "Fix bug" and not "Fixed
    bug" or "Fixes bug." This convention matches up with commit messages
    generated by commands like git merge and git revert.

    Further paragraphs come after blank lines.

    - Bullet points are okay, too.
    - Typically a hyphen or asterisk is used for the bullet, followed by a
      single space. Use a hanging indent.
  
    Fix bug #123 #345
  • For bonus points run and add unit tests
    • Make sure you have added the necessary tests for your changes.
    • Run all the tests to assure nothing else was accidentally broken.

Making Trivial Changes

Documentation

For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in the issue tracker. In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.

    Short (72 chars or less) summary starting with (doc). 
    
    The first line is a real life imperative statement with '(doc)' in
    place of what would have been the ticket number in a 
    non-documentation related commit. The body describes the nature of
    the new documentation or comments added.

Submitting Changes

  • Sign the Contributor License Agreement.
  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the DNN.Platform repository in the DNNSoftware organization.
  • The committers will handle updating the associated issue in the DNN Tracker to ensure it gets the necessary code review and QA.

Acceptance of your Changes

  • We have a group of fellow developers that review pull requests submitted by developers like yourself.
  • If your changes look good, then changes are merged to an appropriate release.
  • We may ask you to make further changes or reject the change (with proper reasonsing - we hope that's not the case though).
  • You should get an email notification as we complete processing of your pull request.

Downloading latest package with your changes

  • As soon as changes are accepted, our team city build server gets into action.
  • New builds are usually available within 10 minutes of acceptance.
  • You can download the latest build by logging as a 'guest user' at: https://build.dnnsoftware.com/

Additional Resources