Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 4.77 KB

CONTRIBUTING.md

File metadata and controls

87 lines (56 loc) · 4.77 KB
Raw

Contributing to The Starred PH

Hi, kamusta?! 🙌 First off, thank you for the interest of contributing to this kind of project. 🙌

Please be informed that the author of this project is new to Open Source. If there seems lacking on this document or in the process as a whole, please feel free to contact rhanmiano29@gmail.com.

Table of Contents

Introduction

Code of Conduct

Getting Started

How can I contribute?

Introduction

This document aims to list down set of guidelines for contributors to strictly adhere to. Please enjoy contributing!

Code of Conduct

For the developers, maintainers and supporters to establish a safe and joyful environment, everyone who will be participating in this project is expected to have read the Code of Conduct and uphold what is provided thereunto.

Getting Started

The project is pretty small, and does not require contributors so much to get involved.

  • First off, contributor must have a good understanding of how Vue and Nuxt work.
  • Basic understanding of unit testing and how it is being implemented in Vue projects using Jest and Vue Test Utils.
  • Styling UI components using TailwindCSS

Please follow along the Setup and Dependencies to setup the project in your local machine.

That is all! Read the remaining sections of this document to get going.

How can I contribute?

Reporting an issue

Before anything else

  • Scan the list of issues and make sure that there is no same issue as what you'll be reporting.
  • For general questions, please do not post it as issue of the project. The maintainer will be providing a channel for questions to be answered accordingly.

If confirmed issue

  • Do check the provided template for issue(s) to see what are the needed details for the maintainer to consider your reported item.
  • Submit your issue.

Adding a feature

Before anything else

  • Make sure that the feature is related to what The Starred PH aims to be.
    • If updates are to be made to the current top most starred Github repositories context, does the feature not pivoting to anything besides showing the most starred repositories, does it supplement the current behaviour?
    • If it is from new platform(see ideas here), is the feature essential to promote our Pinoy developers, creatives and such?
  • Do check the provided template for feature requests to see what are the needed details for the maintainer to consider your feature in mind.
  • Submit your feature request.

Pull requests

Note I encourage first timers 🔰 (as I am new to Open Source also) to participate and unleash that inner nerd in you. You can read guides in here on how to contribute to open source projects.

  • After making sure that all has been read, fork this repo.
  • Clone your forked repo in to your local machine.
    git clone your-forked-repo-in-here
  • The develop branch will be our starting point, to avoid breaking what's in the master
    git fetch && git checkout develop
  • This will allow us to connect to the original remote repository.
    git remote add upstream https://github.com/rhanmiano/the-starred-ph.git
  • To fetch upstream branches.
    git fetch upstream
  • To allow us to pull updates from the original remote develop branch.
    git branch --set-upstream-to=upstream/develop develop
  • Checkout to your branch. Prefix it with feature/ or fix/, whatever is applicable to your updates. git checkout -b ${prefix}/descriptive-branch-name-here
  • Code and push your changes.
  • Submit a pull request. Please do follow the template for requesting one.

Any contributions such as UI/UX enhancements, or enhancements in some of the documentations are very much welcome!

Let us make this a wonderful experience to us all. Thanks!