Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (59 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

98 lines (59 loc) · 4.28 KB

Contributing to mindbuttergold

Welcome! Thank you very much for your interest in contributing. We are grateful for your help in making best practices more tangible and accessible!

mindbuttergold is a public collection of production-quality demonstrations showing modern software and infrastructure best practices. Contributions are open to anyone, as long as they meet the guidelines outlined below.

Table of Contents

Contributing New Ideas

If you have a new idea for a best practice demonstration, but there is no relevant existing repository:

  • Open a new "Idea" post in the Discussions section.
  • If the idea receives at least 10 thumbs up, a maintainer will create a public repository for it (Github doesn't allow community members to create repositories directly). This bar is set high, to help promote engagement and ensure best practices demonstrated are valuable to the community at large.
  • Once the repository is created, anyone can open a PR to contribute to it.

Code Contribution Guidelines

Code should be clear, complete, and fully usable in real-world systems. It should align with mindbuttergold's Guiding Values.

New demonstration contributions must include a README.md that explains how to use the code, including setup, prerequisites, and supporting references about the best practice demonstrated.

Do not include:

  • Placeholder or unfinished code
  • Code copied from other places with a license that does not permit its use in this project
  • Redundant or self-evident code comments
  • Emojis or other random AI-generated artifacts unrelated to functionality

Submissions that don't meet these expectations will be closed.

Commit Requirements

All commits should follow Conventional Commit standards to allow us to perform automated semantic versioning.

Also, please use clear and descriptive commit messages.

Pull Request Requirements

Community PRs must be approved by at least one maintainer before merging.

Maintainers agree to review PRs that meet the contributing guidelines within 1 week of initial submission - to the best of their ability.

Every PR must include:

  • A PR title that follows the same Conventional Commit standards as commits, and is clear and descriptive.
  • All sections of the PR template filled out. You can put N/A for a section if you feel it is not applicable, but a maintainer may ask you to fill it out prior to review / approval.

Code Contribution Process

To contribute code to a repository in this project, follow these steps:

1. Review the Code Contribution Requirements

2. Fork the Repository

Go to the GitHub page of the repository and click the "Fork" button at the top-right corner. This creates a copy of the repository under your GitHub account. See About Forks for more information.

3. Clone Your Fork

git clone <FORKED_REPO_URL>
cd <FORKED_REPO_NAME>

4. Add the Original Repository as Remote Upstream

git remote add upstream <ORIGINAL_REPO_URL>

git remote -v

5. Create a Feature Branch

6. Make Your Changes

7. Commit Your Changes

Review the Commit Requirements.

8. Push Your Branch to Your Fork

9. Open a Pull Request in the Original Repo

Review the Pull Request Requirements.

See Creating a Pull Request From a Fork for more information.

10. Respond to Feedback

Make any requested changes or provide supporting rationale for not making changes. Debate is welcome and encouraged, but abide by the Code of Conduct.