Skip to content

Latest commit

 

History

History
77 lines (61 loc) · 4.02 KB

CONTRIBUTING.md

File metadata and controls

77 lines (61 loc) · 4.02 KB
Raw

Contributing

Table of Contents

  1. Types of contributions we're looking for
  2. Ground rules & expectations
  3. How to contribute
  4. Style guide
  5. Setting up your environment
  6. Community

Types of contributions we're looking for

  • Bug Fixes
  • Function and Class Implementations
  • Makefile edits
  • Implementing Add-On Features
  • etc.

Ground rules & expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):

  • Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
  • Open Source Guides are released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
  • If you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.
  • When adding content, please consider if it is widely valuable. Please don't add references or links to things you or your employer have created as others will do so if they appreciate it.

Setting up your environment

Clone the repository to your local machine

  • git clone https://github.com/Hunter-Open-Source-Club/hacktoberfest21.cpp.git

Build

To run the current build of the program

  • make
  • ./main

How to contribute

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

Open an issue

  • To report an error you can't solve yourself
  • To discuss a higher level idea (vision, mission, impact)
  • To propose a new feature or idea

Open a pull request

  • To submit trivial fixes
  • To start work on a contribution that was asked for

If you don't see your idea listed, and you think it fits into the goals of this guide, open an issue to discuss the details.

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues
  • Post a new issue with a detailed description of the problem
  • Please detail in the issues what the expected behavior is supposed to be, open a new one
  • What is the current behavior
  • What are some possible solutions
  • Steps to reproduce the bug
  • Detailed description of the bug
  • Possible Implementation of fix

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.
  • Ensure the PR description clearly describes the problem and solution.
  • Link the issue number to PR if applicable.

Did you implement a requested feature?

  • Open a new GitHub pull request with the implementation.
  • Ensure the PR description clearly describes the problem and solution.
  • Link the issue number to PR if applicable.

Pull Requests

  • Do not commit/push directly to the master branch. Instead, create a fork and file a pull request.
  • When maintaining a branch, merge frequently with the master.
  • When maintaining a branch, submit pull requests to the master frequently.
  • If you are working on a bigger issue try to split it up into several smaller issues.
  • Please do not use "Draft" pull requests, they clutter our world view. Rather, use issues or discussion topics to discuss whatever needs discussing.
  • We reserve full and final discretion over whether or not we will merge a pull request. Adhering to these guidelines is not a complete guarantee that your pull request will be merged.