Skip to main content

Main Content

Technical Contribution Guidelines

Contributing to Decanter

This project is open source. If you find something broken, confusing, or wrong, please first check the[ issue queue](https://github.com/SU-SWS/decanter/issues). For new issues or feature requests, contributors who post with patches or pull requests and are respectful will be handled first.

Please see our Code of Conduct for contributors.

Using the issue tracker

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests. Please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests.
  • Please do assign a maintainer for review.

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. Use the GitHub 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 branch in the repository.
  3. Isolate the problem – create a live example (e.g., on Codepen) of a reduced test case.

A good bug report shouldn’t leave others needing to chase you for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help our community to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It’s up to you to make a strong case to convince the project’s developers of the merits of this feature. Please provide as much detail and context as possible.

Learn more about how we evaluate feature requests

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please adhere to the coding conventions used throughout a project (whitespace, accurate comments, etc.) and any other requirements (such as test coverage).

Linting is performed on every pull request. Please see STANDARDS.md for more information on standards, conventions, and best practices.

Follow this process if you’d like your work considered for inclusion in the project:

Pull request workflow

  1. Fork the project, clone your fork, and configure the remotes:
    # Clone your fork of the repo into the current directory
    git clone https://github.com/<your-username>/decanter
    # Navigate to the newly cloned directory
    cd decanter
    # Assign the original repo to a remote called "upstream"
    git remote add upstream https://github.com/SU-SWS/decanter
    
  2. If you cloned a while ago, get the latest changes from upstream:
    git checkout master
    git pull upstream master
    
  3. Never work directly on master. Create a new topic branch (off the latest version of master) to contain your feature, change, or fix:
    git checkout -b <topic-branch-name>
    
  4. Commit your changes in logical chunks. Use Git’s interactive rebase feature to tidy up your commits before making them public. Be sure to compile the css before submitting. Be sure to lint the scss before submitting.
  5. Locally rebase the upstream development branch into your topic branch:
    git pull --rebase upstream master
    
  6. Push your topic branch up to your fork:
    git push origin <topic-branch-name>
    
  7. Open a Pull Request with a clear title and description.

IMPORTANT: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project.

CSS Conventions

CSS conventions are maintained through sass and scss linting. Please run your work against the linter configuration files in this directory. For your convenience an NPM based sass linter has been packaged in this repository.

To install you must have NPM installed.

Then run:

npm install
npm run sasslint

This should output any errors the linter can find. Please fix those before submitting a pull request.

Maintainers

If you have commit access, please follow this process for merging patches and cutting new releases.

Accepting PRs

  1. Check that a PR is within the scope and philosophy of the project.
  2. Test the patch locally.
  3. Run PR against linter through either node linters or Code Climate.
  4. Ensure all documentation and commenting is in place.
  5. Squash and merge using command line or Github’s merge button.

Definition of Done

  • Semantic markup
  • Accessible WCAG 2.0 AA (Wave, Voice Over, Keyboard Navigation)
  • Responsive (each breakpoint)
  • Mobile friendly (user experience) no hovers vs taps
  • Works without javascript (good enough state)
  • SASS markup validates with linters
  • Pull request submitted.
  • Code reviewed for formatting, style, and errors (1 or more developers).
  • Code approved and merged into the main branch of theme/module.

Supports browsers:

  • IE 11 ( check clients analytics )
  • EDGE ( < 2 latest versions) Win
  • Chrome ( < 2 latest versions) Win + OSx
  • FireFox ( < 2 latest versions) Win + OSx
  • Safari ( < 2 latest versions) Win + OSx
  • iOS Safari (iphone and tablet)
  • Android (android browser and chrome) (phone and tablet)

Releasing a new version

  1. Include all new functional changes in the CHANGELOG.
  2. Use a dedicated commit to increment the version. The version needs to be added to the CHANGELOG (inc. date), and package.json
  3. The commit message must be of v0.0.0 format.
  4. Create an annotated tag for the version: git tag -m "v0.0.0" 0.0.0.
  5. Push the changes and tags to GitHub: git push --tags origin master

Server strategy

Semver is a widely accepted method for deciding how version numbers are incremented in a project. Versions are written as MAJOR.MINOR.PATCH.

Any change that is backwards-breaking will result in a new major release. Others changes with no impact on rendering are considered backwards-compatible and will result in a new patch release.

Testing your code for Accessibility

Before submitting a PR for review, please ensure that your code meets basic accessibility requirements. To test your code you should check the following:

  • HTML Validation - https://validator.w3.org/ - if a page doesn’t pass HTML Validation, it’s likely to have issues with accessibility.
  • WAVE, AXE, etc. These are handy tools. They are easy to use and are great for spot checking work. It may be that one of these tools pick up an issue that another tool missed.