Skip to content

Latest commit

 

History

History
110 lines (73 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

110 lines (73 loc) · 3.26 KB
Raw

Contributing to SocialRepo

First off, thanks for taking the time to contribute!

All types of contributions are encouraged and valued. See the Table of Contents. We are looking forward to your contributions.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it and make sure to mention the creator @Param3021.
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

Please adhere to the basic guidelines and Code of Conduct in Open Source Projects.

Project Details

Kindly go through the Project Details to understand the project and what you can contribute.

Extension setup

Fork and clone the repository

git clone https://github.com/Param302/SocialRepo.git

Create and checkout to the new branch.

git checkout -b <branch_name>

After doing the changes, setup the extension in your browser.

Chrome

Open chrome://extensions/ in your browser.

Enable the Developer mode on the top right corner.

Click on Load unpacked and select the src folder.

The extension will be added in your browser.

Click on Puzzle icon in the top right corner of the browser and pin the extension.

Now you can use the extension in your browser.

If you are facing any issue, feel free to open an issue in the repository.

Project setup

Important

Before you start contributing, make sure you have read the Project Details and understood the project requirements.

For coding contribution, make sure you have understood the Code Structure, read the Code Guidelines used in the project.

Fork and clone the repository

git clone https://github.com/Param302/SocialRepo.git

Create and checkout to the new branch.

git checkout -b <branch_name>

Add the changes

git add .

Commit your change with a proper messagge

git commit -m "Enter your message here"

Push your changes to your forked repository

git push origin <branch_name>

Create a pull request

Once you are done with the changes you wanted to add make the Pull Request (PR) to main branch of SocialRepo repository.

Getting Help

If you have any questions or need assistance, feel free to open a topic in discussions or reach out to the project maintainer for the support.

Acknowledgements

We appreciate all contributions to SocialRepo, whether they come in the form of code, documentation, bug reports, or feature requests. Thank you for helping to improve the project!

Happy coding!