Skip to content

Commit

Permalink
Merge branch 'develop' into issue/1761
Browse files Browse the repository at this point in the history
* develop: (35 commits)
  Update CONTRIBUTING.md
  Fix typo
  minor code improvements
  added review
  ignore colorLabel attribute from being used in the editor schemas
  Re-add hack for gmcq/mcq dependency
  less improvements and use vars to define colors
  add translation and description text to color label popup
  Log plugin install error
  Add extra log funcs
  Fix function
  Use strict equality
  update archive dependecy
  Don't fail on plugin install error
  add _colorLabel to component schema
  Fixes: #1928
  Fix and refactor helper
  styling
  update originView to set colorlabel attribute
  add colorLabelPopupView
  ...
  • Loading branch information
taylortom committed Apr 24, 2018
2 parents 1066b09 + 4458c4b commit 8563d4a
Show file tree
Hide file tree
Showing 32 changed files with 957 additions and 567 deletions.
67 changes: 27 additions & 40 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,38 @@
# How to contribute

We heartily welcome contributions to the source code for the Adapt Authoring
project. This document outlines some contributor guidlines to help you get
started.

## Getting Started

* Make sure you have a [GitHub account](https://github.com/signup/free)
* Pick an open issue from the list [here](https://github.com/adaptlearning/adapt_authoring/issues) OR
* Submit a ticket for an issue you have noticed
* If submitting a bug, clearly describe the issue including steps to
reproduce and add the "bug" label
* If submitting a request for a new feature, add the "enhancement"
label
* Fork the repository on [GitHub](https://github.com/adaptlearning/adapt_authoring)
* Follow the developer set-up guide [here](https://github.com/adaptlearning/adapt_authoring/wiki/Developer's-Install)

We try to add one of the following labels to all our issues to indicate difficulty:

* Easy
* Medium
* Hard
* Insane

Picking up an "Easy" issue is a good way to start contributing if you have
not worked on a nodejs or backbone project before. Otherwise, you should have
no problems working on a "Medium" issue. "Hard" and "Insane" issues are
targeted at contributors that have had extensive experience of developing
for this project.
We heartily welcome contributions to the source code for the Adapt authoring project. This document outlines some contributor guidelines to help you get started.

## Before you begin

* Make sure you have a [GitHub account](https://github.com/signup/free), as all contributions are made through GitHub.
* Fork the [`adapt_authoring`](https://github.com/adaptlearning/adapt_authoring) repository to your GitHub account.
* Follow the [developer set-up guide](https://github.com/adaptlearning/adapt_authoring/wiki/Developer's-Install) to get a developer instance of the authoring tool installed.

## Finding work

* Pick an open issue from the list [here.](https://github.com/adaptlearning/adapt_authoring/issues)
* Create a new ticket for the issue you have noticed, following our guidelines on [submitting new bugs and features.](https://github.com/adaptlearning/adapt_framework/wiki/Bugs-and-features)
* If submitting a new ticket, we recommend getting the go-ahead for the change from the core team before you start work.

### Use the labels

We add difficulty rating labels to issues to give developers an idea of the work involved (always prefixed with `D:`). Picking up a `D: beginner` or `D: easy` issue is a good place to start if you're new to the project, and have limited Node.js and Backbone.js experience. For more confident developers, `D: medium` issues should be no problem. Any `D: hard` and `D: insane` issues are likely to involve very complex solutions, and potentially collaboration, to solve. Due to the work involved, these should only be attempted by developers with an extensive knowledge of the codebase, and a good working relationship with the core team.

## Making Changes

* Create a new branch named for the issue that you are fixing, and base it on
the target branch (e.g. `git checkout -b issues/123 origin/develop`)
* Make your changes
* Add some tests if your changes warrant it
* Run all tests using `npm test`
* Commit your changes using [best practice](http://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines) in your commit message and take
advantage of GitHub's built in features to [close issues via commits](https://help.github.com/articles/closing-issues-via-commit-messages/)
* Create a new branch for the issue that you are fixing:
* Make sure to base it on the correct parent branch; in most cases this will be develop. Getting this step wrong may cause you a lot of heartbreak when it comes to merging later on, so it's worth checking before starting work.
* Name your branch according to the issue it addresses (i.e. `issue/1234`).
* Create your branch (e.g. `git checkout -b issue/123 origin/develop`).
* Make your changes (please make sure that your commit messages stick to the [guidelines](http://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines), and take advantage of GitHub's built in features to [close issues via commits.](https://help.github.com/articles/closing-issues-via-commit-messages/)
* Add unit tests to cover your new functionality, if appropriate.
* Run the existing unit tests using `npm test` (and ensure they pass!)

## Submitting Changes

* Push your changes to your fork of the adapt_authoring repository
* Submit a pull request using the GitHub interface, and reference the issue
number
* The core team will be automatically notified of your changes, but you can
also bring it to our attention via the [gitter.im channel](https://gitter.im/adaptlearning/adapt_authoring)
* Push your changes to your personal fork of the `adapt_authoring` repository.
* Submit a pull request using the GitHub interface, and make sure to link to the issue you're addressing.
* The core team will be automatically notified of your changes, but you can also bring it to our attention via the [gitter.im channel](https://gitter.im/adaptlearning/adapt_authoring).

# Additional Resources

Expand Down
2 changes: 1 addition & 1 deletion Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ module.exports = function(grunt) {
{
expand: true,
flatten: true,
src: ['frontend/src/core/libraries/ace/**/*'],
src: ['frontend/src/libraries/ace/*'],
dest: 'frontend/build/js/ace'
}
]
Expand Down
Loading

0 comments on commit 8563d4a

Please sign in to comment.