Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 3.8 KB

CONTRIBUTING.md

File metadata and controls

59 lines (36 loc) · 3.8 KB

SheSharp Contributing Guide

Welcome to SheSharp Knowledge Hub! Thank you for expressing interest in contributing to this initiative ♥️.

This repository contains a list of resources for growing and improving as a developer. Our goal is to help as many developers out there.

Besides adding resources to our lists, we welcome bug fixes, typo fixes, and feedback! However, we prioritize PRs from existing community members and underrepresented genders in tech to support our mission.

We take our Code of Conduct very seriously, and all contributors must abide by it. So please take time to read it before contributing.

New Contributors

If you're new to open source, check out the resources below to familiarize yourself with open source:

Working With Issues

If you find an issue you would like to work on, comment on it, and a maintainer will respond and assign it to you. Only work on changes and create a PR if it's assigned to you.

We only accept PRs from contributors who get assigned to the issues.

Getting Started

  1. Fork this repository.
  2. Clone the forked repository to your local machine.
  3. Create a new branch with a name related to your contribution, for example, feat/add-resource.
  4. Work on your changes.
  5. Add and commit your changes with a descriptive commit message.
  6. Push the new branch to your remote forked repository.
  7. Create and submit a Pull Request.

Resolve Merge Conflicts

When you encounter merge conflicts, you need to resolve them before your pull request can be merged into the main branch.

Merge conflicts usually occur when changes are on the same line(s) and file(s) from two different branches. It is common to encounter merge conflicts when contributing to open source.

You can resolve the conflict directly on GitHub. But it's highly recommended to resolve the conflicts locally.

What if the Resource You would Add doesn't Fit any Existing Categories?

If the category that best fits your contribution doesn't yet exist, please create a new Markdown file in the resources folder and add it there. You also need to add the path to this new file to the "Resources" section in the README.md.

Keep in Mind

Please be sure to keep the following in mind before adding a new resource:

  • Make sure you added the resource to the correct category.
  • We accept all resources, but most favorably, resources that you've used before or you know are of exceptional quality.
  • Ensure your resource doesn't exist in the repo before contributing.
  • Double-check to make sure the link to your resource is working.

And that's it!

With love,
SheSharp ❤️