Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (32 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 1.54 KB
Raw

Contributing to CSS3 Calculator

Thanks for your interest in improving this project! It's a small, dependency-free project, so contributing is easy.

Getting started

  1. Fork the repository and clone your fork.
  2. Open index.html directly in a browser, or run the bundled preview server: 
    node server.js   # then visit http://localhost:4600
  3. Create a branch for your change: 
    git checkout -b feature/my-improvement

Guidelines

  • No build step, no dependencies. Keep it plain HTML, CSS, and vanilla JS.
  • Match the existing style. Tabs for indentation, and follow the naming conventions already in css/style.css (BEM-ish calc__* / key--*) and js/calculator.js.
  • Theme with CSS custom properties. Add colors as variables in :root and [data-theme='light'] rather than hard-coding them.
  • Test both themes and mobile width before opening a pull request.
  • Keep the JavaScript readable and commented where the intent isn't obvious.

Submitting changes

  1. Commit with a clear, descriptive message.
  2. Push to your fork and open a pull request against master.
  3. Fill out the pull request template and describe what changed and why.
  4. Link any related issue (e.g. Closes #12).

Reporting bugs & ideas

Use the issue templates to file a bug report or suggest a feature. Please include steps to reproduce and your browser/OS for bugs.

By contributing, you agree that your contributions will be licensed under the project's MIT License.