Skip to content

Latest commit

 

History

History
105 lines (70 loc) · 5.67 KB

CONTRIBUTING.md

File metadata and controls

105 lines (70 loc) · 5.67 KB
Raw

Contributing

So you're interested in giving us a hand? That's awesome! We've put together some brief guidelines that should help you get started quickly and easily.

There are several ways to get involved, this document covers:

Reporting An Issue

https://github.com/infor-design/enterprise/issues

Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Git issue search - check if the issue has already been reported.

  2. Check if the issue has been fixed - try to reproduce it using the latest master.

  3. Isolate the problem - create a reduced test case and a live example.

    Examples of reduced test cases are:

    • Take an existing example and modify it to resemble the issue, this is ideal as we can include this in our init tests to avoid future breakages
    • Create an example using a tool like jsfiddle (the enterprise scripts can be upload on this site)
    • Any Other runnable code

    Spend a little time in recreating and isolating the issue and you might learn and discover the solution.

    ⛔ Do not ⛔

    • Send a video in place of a reduced test case
    • Send a link to your application
    • Just send an image of the source code

    If a video is useful to show the problem please use a cross platform format such as MP4 and .webm for the video. We have found Chrome plugin Screencastify - Screen Video Recorder to be useful.

Feature Requests

Feature requests are welcome. Before you submit one be sure to have:

  1. Does your idea fits with the scope of the project? Might better fit being an app/plugin/extension?
  2. Would anyone else but your team would want this feature?
  3. Remember, it's up to you to make a strong case to convince the merits of this feature. "We did it before" isnt strong enough.

Submitting Pull Requests

Pull requests are awesome. If you're looking to raise a PR for something which doesn't have an open issue, please think carefully about raising an issue which your PR can close, especially if you're fixing a bug.

If you'd like to submit a pull request you'll need to do the following:

  1. Forking the repo. Navigate to Github Repository and click the "Fork" button in the top right corner of your browser.

  2. Clone the Repository to your machine.

  3. Make your changes to your local fork for the proper branch.

  • Almost all development will be done on branches from master.
  • Occasionally there will be a need to contribute to a version branch (i.e. 4.9.x) in which case you want to branch off of one of those.

If you are unsure, just ask someone on the team so you don't have to redo your branch.

  1. Commit your changes locally. Try to follow the standards for your commit message outlined below.

  2. Pull & Rebase to the latest version of the controls before you submit.

    • If enough time passes between your original clone and the completion of your changes, the main repository may have changed and some files you've edited may be out of sync.
    • To re-sync your remote branch and clone, use the following after committing your changes: 
      git pull --rebase {remote}/{branch}

    Note: You may need to merge some files or fix some conflicts.

  3. Push your changes to your remote repository. Use git push {remote} {branch} to push your changes to your branch on the remote repository.

  4. Create a pull request to the proper branch

  • Normal changes get merged into master
  • Version specific changes need to go into that specific version branch

See help.github.com for further information.

Testing and Quality Assurance

Never underestimate just how useful quality assurance is. If you're looking to get involved with the code base and don't know where to start, checking out and testing a pull request is one of the most useful things you could do.

If you want to get involved with testing Enterprise, there is a set of QA Documentation on the wiki.

Essentially though, check out the latest master, take it for a spin, and if you find anything odd, please follow the bug report guidelines and let us know!