Skip to content

Latest commit

 

History

History
97 lines (68 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

97 lines (68 loc) · 3.41 KB

Contributing to Commuse

First off, thank you for considering contributing to Commuse! It's people like you that make Commuse such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Commuse. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Commuse, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps.

Contributing Code

Setting Up Your Development Environment

  1. Fork the Commuse repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/berkmancenter/commuse.git
cd commuse
  3. Create a branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
    or 
    git checkout -b fix/your-bug-fix
  4. Make your changes and commit them with a clear commit message.

Creating a Pull Request

  1. Push your changes to your fork on GitHub: git push origin feature/your-feature-name
  2. Go to the Commuse repository on GitHub and click the "New pull request" button.
  3. Select your fork and the branch you just pushed from the dropdown menus.
  4. Add a title and description for your pull request, explaining your changes and the reasons for them.
  5. Click "Create pull request".

Pull Request Guidelines

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the JavaScript styleguide.
  • End all files with a newline
  • Make sure your code is properly tested
  • Keep your pull request focused in scope and avoid including unrelated commits

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

Documentation Styleguide

  • Use Markdown.
  • Reference the methods and classes in markdown using the following syntax:
    • Class: {ClassName}
    • Method: {ClassName}#{methodName}

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that are bugs.
  • enhancement - Issues that are feature requests.
  • documentation - Issues for improving or updating our documentation.
  • good first issue - Good for newcomers.

Thank you for contributing to Commuse!