Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 4.97 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 4.97 KB
Raw

Contributing to the Maximum PC Builds Archive

🎉 Thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to the Maximum PC Builds Archive project 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.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to our Discord.

New Contributor Guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

How to Contribute

Did you want to add a new Maximum PC issue?

  • Ensure the issue has not already been added by looking through the folder tree on GitHub.
  • If you are unable to find the issue, create a list for each of the builds on PCPartPicker. For older issues, create one for each of the Budget, Mid-Range, and Turbo categories. If the issue is from 2020 or newer, create create one for each of the AMD Budget, Intel Budget, AMD Mid-Range, Intel Mid-Range, AMD Turbo, and Intel Turbo categories.
  • Create a Markdown page for each of the builds in the respective year and month folders. Then, create an HTML page for each of the builds on the website in the gh-pages branch.
  • Finally, update the README Table of Contents with links to the PCPartPicker, Markdown, and Web versions of the builds.

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
  • Use the issue templates to create the issue. They include step by step guidelines and have lists of things that should be included.

Did you write a patch that fixes a bug or updates the documentation?

  • Open a new Pull Request on GitHub with the patch.
  • Ensure the pull request description clearly describes the problem and solution. Be sure to include a title, and as much relevant information as possible. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

  • Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Maximum PC Builds Archive are still accepted! Just follow the same instructions as above.

Do you intend to add a new feature or change an existing one?

  • Ensure the feature was not already introduced by searching on GitHub under Issues. Look for those under the enhancement tag.
  • If you're unable to find an open issue addressing the new feature, open a new one!

Do you have questions about the source code?

  • Ask any question about how to use Maximum PC Builds Archive on our Discord.
  • If it does not get answered, open an issue.

Attribution

This document is adapted from the Contributing documents of Rails, the GitHub Docs, Atom, and OpenGovernment.