Skip to content

Latest commit

 

History

History
117 lines (77 loc) · 7.44 KB

README.md

File metadata and controls

117 lines (77 loc) · 7.44 KB

Graphy in 100 Days of Feature Request

We are so excited to have Graphy in the first edition of 100 Days of Feature Request. This is the offcial repository of brand Graphy for 100 Days of Feature Request, where you will be able to submit your Pull Request regarding any new feature as a contribution for the contest.

About the Brand

Graphy is an online platform that empowers content creators and experts to scale their online business, brand, and community by creating custom courses, building beautiful no-code websites, or launching their own white-labeled app. Our mission is to equip the creators with all the tools required to flourish in a world where online creators are in charge of their lives.

Problem Statements

Statement No. 1

Problem - Currently, Graphy have a free trial that helps the user explore the functionalities in the product. But, to make the purchase decision, the team want the user to identify the right value in the product.

Approach to Solve - The product should be completely self-serve till the point where they find value in the product, without the intervention of any human support. There are 3 categories across which critical actions are bucketed:

  • Setting up their course platform
    • Integrate payments
    • Set up a custom domain
    • Customize the landing page
  • Launching and selling courses
    • Set up the course: name, description, etc
    • Define course curriculum
    • Upload content set up content security
    • Customize course landing page
  • Conducting sessions, live quizzes, interacting, etc.
    • Scheduling and conducting a session/quiz
    • Engaging in the community forums
    • Sending notifications, writing blogs, etc.

Output - You have to create an onboarding journey for the user, starting right after they landed on the landing page, helping them find the right value in the product that they have been looking for, and eventually influencing them for purchasing any suitable plan.

Essentials - Before getting started, it is highly recommended to check out the product by clicking here. Also, check out the features and the limitations of the free plan by clicking here.

Note - Submissions should be complete and of production quality with good UI and UX. Only the ones that meet the criteria will be eligible.

You can find the same problem statement as issues. Read the issues and mention them while submitting a Pull Request.

Rewards

Graphy will award the contributors with the following perks:

  • Top 3 contributors will get swags, goodies, books and certificates.
  • All contributors will be eligible for Participation Certificates.

Table of Contest

Contributing

Getting Started

To get started with the contribution in the Graphy repository, simply fork it into your local GitHub account. Make the changes in the forked repository. In this case, the change will be related to the feature that you will be putting in. You can also clone the repository first, and then fork and push it along with the changes. This will also raise a PR.

Note: Please be aware that Graphy will not share any codebase for this challenge. You are free to develop your own solution using your creativity and imagination (Like that in a hackathon). But, you have to keep the problem statament in mind while developing a solution.

Submission Guide

To make a submission for the brand Graphy in 100 Days of Feature Request, as a first step, fork the repository by clicking the fork button at the right hand corner. In the forked repository, you will be able to make changes and upload your code regarding the feature that you will be making and contributing.

In the forked repository, create a folder and in that folder, add all the required codes and documents needed for the feature. The folder name should contain your name and the name of the feature which you have built. After naming the folder and later on adding and uploading the contents inside the folder, you will be ready to raise a pull request.

In the folder, you must have to make a README.md file which will have a detailed description about the feature solution.

When you are raising a Pull Request, keep in mind to give a proper title of the PR which will be relevant to the changes. In the description section, give a proper description that will tell the summary of the feature request that you have built. Also, you can use markdown in the description that will help you to embed any link or add anything relevant with the description.

Creating Pull Requests

  1. When you're ready to submit your changes, add a descriptive title and comments to summarize the changes made.
  2. Select Create a new branch for this commit and start a pull request.
  3. Check the Propose file change button.
  4. Scroll down to compare changes with the original document.
  5. Select Create pull request.

Commenting on Pull Requests

Once a pull request is submitted, multiple committers may comment on it and provide edits or suggestions which you can commit directly. You can also add line comments. Take a look at Commenting on pull requests for more details.

Labelling Pull Requests

A raised Pull Request will be labelled according to the work that has been done in the Pull Request. There are several labels to determine the work that is on-going with the Pull Request. For example, we requested a change in the pull request from the submitter, then the PR will be labelled as awaiting submitter action.

Reviewing Pull Requests

The Pull Requests will be reviewed on a first come first serve basis. The community and product team of SAWO Labs will be responsible for the reviewing of Pull Requests. Keep in mind that spams will not be tolerated.

While reviewing the Pull Requests, we may contact the submitter of the PR regarding any changes that need to be made. If the submitter doesn't respond even after making several calls, then we will be forced to close the PR by labelling it as incomplete.

Once the review process is complete, the change is either merged into master and pushed immediately or merged into the release branch and pushed in alignment with the release. The branch is then deleted.

Building and Validating

If you've downloaded the repository and are making a feature on your local machine, you can generate the HTML files from markdown. You can review your changes before you commit them or create pull requests.

Note: Commands can be executed on Linux, Mac, and Windows (using Powershell).

  1. Open a terminal window, then clone a forked copy of the Graphy repository by running the following command::
https://github.com/Sawo-Community/Graphy.git
  1. Install pipenv by using one of the following commands based on your operating system:

For Mac users where Homebrew is installed:

brew install pipenv  

For other operating systems

pip install pipenv