Skip to content

Latest commit

 

History

History
167 lines (105 loc) · 5.86 KB

CONTRIBUTING.md

File metadata and controls

167 lines (105 loc) · 5.86 KB
Raw

👨‍💻 Prerequisite Skills to Contribute

Basics:

Front-end:

💥 How to Contribute

PRs Welcome Open Source Love

  • Take a look at the existing Issues or create a new issue!
  • Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
  • Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.

⭐ HOW TO MAKE A PULL REQUEST:

1. Start by making a Fork of the thecyberhub.org repository. Click on the Fork symbol at the top right corner.

2. Clone your new fork of the repository in the terminal/CLI on your computer with the following command:

git clone https://github.com/<your-github-username>/thecyberhub.org

3. Navigate to the newly created thecyberhub.org project directory:

cd thecyberhub.org

4. Set upstream command:

git remote add upstream https://github.com/th3cyb3rhub/TheCyberHUB.git

5. Create a new branch:

git checkout -b YourBranchName

6. Sync your fork or your local repository with the origin repository:

  • In your forked repository, click on "Fetch upstream"
  • Click "Fetch and merge"

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream
git merge upstream/main

GitHub Docs for Syncing

7. Make your changes to the source code.

8. Stage your changes and commit:

⚠️ Make sure not to commit package.json or package-lock.json file, until and unless you have installed the new packages.

⚠️ Make sure not to run the commands git add . or git add *. Instead, stage your changes for each file/folder

git add <changed-files>
git commit -m "<your_commit_message>"

9. Push your local commits to the remote repository:

git push origin YourBranchName

10. Create a Pull Request!

11. Congratulations! You've made your first contribution to thecyberhub.org! 🙌🏼

🏆 After this, the maintainers will review the PR and will merge it if it helps move the Cryptoverse project forward. Otherwise, it will be given constructive feedback and suggestions for the changes needed to add the PR to the codebase.

Run project locally

Start the thecyberhub.org application by typing this command:

npm run dev

Open the browser to visit the website at http://localhost:3000

Style Guide for Git Commit Messages 📝

How you can add more value to your contribution logs:

  • Use the Conventional Commits way when writing your commit messages.

  • The most important prefixes you should have in mind are:

    • fix: which represents bug fixes, and correlates to a SemVer patch.
    • feat: which represents a new feature, and correlates to a SemVer minor.
    • feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.

  • Use the present tense. (Example: "Add feature" instead of "Added feature")

  • Use the imperative mood. (Example: "Move item to...", instead of "Moves item to...")

  • Limit the first line (also called the Subject Line) to 50 characters or fewer.

  • Capitalize the Subject Line.

  • Separate subject from body with a blank line.

  • Do not end the subject line with a period.

  • Wrap the body at 72 characters.

  • Use the body to explain the what, why, vs, and how.

  • Reference Issues and Pull Requests liberally after the first line.

Storybook :

Introduction

Storybook is a powerful tool for developing and testing your UI components in isolation.

It allows you to visualize different states of your components and interact with them in a sandbox environment.

To view and run Storybook, use the following command in your terminal:

npm run storybook

This will start the Storybook server on port 6006.

Open your browser and navigate to http://localhost:6006 to access the Storybook interface.

For more info and examples you can check storybook documentaion

💥 Issues

In order to discuss changes, you are welcome to open an issue about what you would like to contribute. Enhancements are always encouraged and appreciated.

All the best! 🥇

built with love