Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 3.84 KB

CONTRIBUTING.md

File metadata and controls

66 lines (40 loc) · 3.84 KB

Contributing to Practice Domains

We're thrilled that you're interested in contributing to the Practice Domains! This document provides a set of guidelines for contributing to this practice domain's mono-repo on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Our Practice Domain's Vision

The goal is to create a place where you can bring back lessons learned from your projects, to repurpose open-source work that you've already done and invested your time in, and to share that with the rest of the herd. This is a place where you can find resources, examples, and best practices to help you get started on your next project.

Try to think of what you'll need on your own project in the future and try to find people to collaborate on generalized solutions.

Try to remember what tools or examples you wish you had when you started your current project.

Getting Started

Join the Conversation

  • Slack Channel: We recommend joining our Slack channel #domain-<practice> to connect with other contributors and stay updated with discussions.
  • Weekly Check-ins: You're welcome to attend our weekly 15-minute check-ins. This is a great opportunity to ask questions, share ideas, and coordinate with others.

Understand Our Workflow

  • Take a moment to familiarize yourself with our project management tool, GitHub Projects, and how we organize tasks.
  • Review the README.md for an overview of the domain, including technologies used and project structure.

How to Contribute

Reporting Bugs

  • Use the Issue Tracker: Report bugs by creating a new issue in the repo.
  • Provide Detailed Information: Include as much information as possible.

Suggesting Ideas

  • Ideas suggestions are tracked as GitHub issues.
  • Use a clear and descriptive title for the issue to identify the idea or problem to solve.
  • Provide as much information as possible about the idea, project use-case, or active problem that you're trying to solve for.
  • Assign the relevant Milestone and Labels to the issue.

Pull Requests

  • Clone the Repo: Clone it locally.
  • Create a Branch: Branch from the main development branch. Use a clear branch name related to the issue you're addressing.
  • Make Your Changes: Work on the changes as per the issue you're addressing. Ensure you adhere to the coding standards and guidelines specific to the practice domain.
  • Commit Your Changes: Use clear and concise commit messages. Prefix your commit message with the issue number if applicable.
  • Open a Pull Request (PR): Push your changes to your branch and then open a pull request. Fill out the PR template with all the required information.
  • Review Process: The practice team will review your PR. Be open to discussions and making requested changes. Once approved, the team will merge your PR.

Code Review Process

  • All contributions are subject to code review. Our goal is to ensure high-quality and consistent contributions.
  • Reviewers will provide feedback if changes are needed. Engage in constructive dialogue and work together towards improving the contribution.

Community and Behavioral Expectations

  • We strive to maintain a welcoming and inclusive environment.
  • Participation in harassment, discrimination, or offensive behavior is not tolerated.

Recognition of Contributions

  • Contributors are recognized in our project releases. We value your hard work and want to make sure the community in Fearless knows about your contributions!

Questions?

  • If you have any questions or need further clarification, please reach out to the Practice manager or post in the Slack channel.

Thank you for contributing to the Practice Domains! Your efforts are helping to enhance our collective knowledge and capabilities.