Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

76 lines (48 loc) · 2.76 KB
Raw

Contributing Guidelines

Welcome to SheSharp! Thank you for considering contributing to our open source projects. Here you will find our general guidelines for contributing. Please note that certain repositories may have slightly different guidelines.

We appreciate all kinds of contributions. 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. 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 after it's assigned to you.

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

How to Contribute

1. Finding Bugs or Suggesting Improvements

  • If you find a bug or have a suggestion, create a new issue.
  • Select the appropriate template for bug reports or suggestions.
  • Fill in the details and submit the issue.
  • If you want to work on the issue, comment on it and wait until a maintainer assigns it to you before you start work on changes.

2. Making Changes

  • Fork the repository by clicking the "Fork" button.

  • Clone your fork to your local machine and navigate to it:

    git clone https://github.com/your-username/project-name.git
cd project-name

  • Create a new branch for your changes:

    git checkout -b your-feature

  • Make your changes in the new branch.

  • Add and commit your changes:

    git add .
git commit -m "Brief description of your changes"

  • Push your changes to your fork:

    git push origin your-feature

3. Creating Pull Requests

  • Go to your forked repository on GitHub.
  • Click the green "Compare & pull request" button.
  • Fill in the pull request form and click the green "Create pull request" button at the bottom.

License

By contributing, you agree that your contributions will be licensed under the LICENSE of this project.

Need Help?

If you have any questions or need assistance, feel free to reach out at the open-source channel on Slack or open a discussion in the discussion board that you can find at the top bar of this repository.

Thank you for contributing to our project! 🚀