Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

76 lines (47 loc) · 3.06 KB
Raw

Contributing to Ontario.ca Frontend

Thank you for your interest in contributing to Ontario.ca Frontend. We appreciate your desire to enhance the digital services provided to the people of Ontario. This document provides guidelines for contributions to ensure a seamless collaboration process.

Before jumping into a PR, be sure to search existing PRs or issues for an open or closed item that relates to your submission.

Code of conduct

We are committed to providing a welcoming and inclusive experience for everyone. We expect all contributors to adhere to the code of conduct. By participating in this project, you agree to abide by its terms.

Getting started

Reporting bugs

Before submitting a bug report, please ensure that your issue hasn't already been reported by searching through the issue tracker. When reporting a bug, include as many details as possible, such as:

  • A clear and descriptive title
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Any relevant screenshots or logs

Suggesting enhancements

Enhancement suggestions are welcome! Please submit them as new issues in the issue tracker, with a clear and detailed explanation of the feature you would like to see, its benefits, and any potential implementation details you might have in mind.

Making contributions

Pull requests

  1. Fork the repository: Start by forking the repository to your GitHub account.

  2. Clone your fork: Clone your fork to your local machine, and set up the upstream remote:

    git clone https://github.com/your-username/ontario-frontend.git
cd ontario-frontend
git remote add upstream https://github.com/ongov/ontario-frontend.git

  3. Create a branch: Create a new branch for your contribution:

    git checkout -b feature/my-new-feature

  4. Make your changes: Implement your changes, adhering to the coding standards and guidelines provided.

  5. Commit your changes: Write clear, concise commit messages, explaining the reasoning behind the changes made.

  6. Push to your fork: Push your changes to your fork:

    git push origin feature/my-new-feature

  7. Submit a pull request: Go to the original ontario-frontend repository, and you'll see a prompt to submit a pull request from your new branch.

Pull request checklist

Ensure your pull request adheres to the following guidelines:

  • Include a clear description of the changes.
  • Reference any related issues.
  • Ensure your code adheres to the coding standards.
  • Update any relevant documentation.
  • Include tests for new functionalities or fixes.

Additional resources

Questions?

Feel free to reach out to the project maintainers if you have any questions or need further guidance on contributing.