Skip to content

Latest commit

 

History

History
144 lines (86 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

144 lines (86 loc) · 4.38 KB

Contributing Guide

Thank you for investing your time in contributing to our project! Any contribution you make will be appreciated ✨.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Find an issue you would like to take

Write a comment in the issue

Saying you would like to the take the issue. Ask if you have any questions. Get assigned to the issue.

Fork the repository

Fork the project on GitHub

Clone the project

Clone your fork locally. Do not clone the original repository unless you plan to become a long-term contributor and have been given permission to do so.

git clone https://github.com/[your-github-user]/Kef-Code.git
cd Kef-Code

Install dependencies

Install the project dependencies:

npm i
# or:
yarn

Create a branch

Create and check out your feature branch:

git checkout -b my-new-feature

Getting Started

  • Go to .env.example and copy the file.
  • Create .env.local file and paste.
  • In bash/Linux terminal, create your secret: openssl rand -hex 32` or go to https://generate-secret.now.sh/32

To get your GOOGLE_CLIENT_ID & GOOGLE_CLIENT_SECRET:

Make changes locally

Commit your changes

git commit -m 'Add some feature'

Sync to Remote Before PR

If you see that your forked repo on github is behind some commits, you may want to get it up to date to avoid conflicts.

  • Sync your forked repo on GitHub
  • Update you local main - git.
  • Update you local branch - git:
git pull origin my-new-feature
  • This will pull and sync your local branch to the remote main repo.

Push your changes

Push your changes to remote origin:

git push -u origin my-new-feature

Create a pull request

When you're finished with the changes, create a pull request (on GitHub), also known as a PR.

Rebase Git Branch

Sometines, when you made a PR, and there are some changes needed before it could be merged, syncing your local git may not work. Then, you might want to rebase your local branch onto the remote. There are different ways to achive that, here is one that worked for me:

# fetch the latest changes from a remote git repository:
git fetch

# Integrating changes:
git rebase origin/main

Issues

Create a new issue

If you spot a problem in the codebase that you believe needs to be fixed, or you have an idea for a new feature, take a look at the Issues.

If you can't find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels and projects to find issues that need attention.

Then, fork the repository (if this is your first contribution to this project. Otherwise, sync your fork), create a branch, and make your changes.

Finally, open a pull request with the changes.

Your PR is merged

Congratulations 🎉🎉 The GitHub team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the Kef-Code.

Credits

This Contributing Guide is adapted from GitHub docs contributing guide.