diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..11d314be --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +github: [kabir0x23] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c7ba405c..92ee8d08 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,13 @@ blank_issues_enabled: false contact_links: + - name: Security Issues + url: https://twitter.com/thecyberw0rld + about: For security related issues, contact us on Twitter. + - name: Discord community url: https://discord.gg/QHBPq6xP5p about: Join our inclusive Discord community. + - name: Our socials url: https://linktr.ee/thecyberworld about: Feel free to contact us via your preferred platform. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..75b10631 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,128 @@ +## 👨‍💻 Prerequisite Skills to Contribute + +Basics: + - [Git](https://git-scm.com/) + - [Markdown](https://www.markdownguide.org/basic-syntax/) + +Front-end: + - [React](https://reactjs.org/) + - [Ant Design](https://ant.design/) + +--- + +## 💥 How to Contribute + +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/thecyberworld/thecyberhub.org/pulls) +[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/thecyberworld/) + +- Take a look at the existing [Issues](https://github.com/thecyberworld/thecyberhub.org/issues) or [create a new issue](https://github.com/thecyberworld/thecyberhub.org/issues/new/choose)! +- [Fork the Repo](https://github.com/thecyberworld/thecyberhub.org/fork). Then, create a branch for any issue that you are working on. Finally, commit your work. +- Create a **[Pull Request](https://github.com/thecyberworld/thecyberhub.org/compare)** (_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**](https://github.com/thecyberworld/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: +```bash +git clone https://github.com//thecyberhub.org +``` + +**3.** Navigate to the newly created thecyberhub.org project directory: +```bash +cd thecyberhub.org +``` + +**4.** Set upstream command: + +```bash +git remote add upstream https://github.com/thecyberworld/thecyberhub.org.git +``` + +**5.** Create a new branch: +```bash +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: + +```bash +git fetch upstream +``` + +```bash +git merge upstream/main +``` + +### [GitHub Docs](https://docs.github.com/en/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github) 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 + +```bash +git add +``` + +```bash +git commit -m "" +``` + +**9.** Push your local commits to the remote repository: + +```bash +git push origin YourBranchName +``` + +**10.** Create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)! + +**11.** **Congratulations!** You've made your first contribution to [**thecyberhub.org**](https://github.com/thecyberworld/thecyberhub.org/graphs/contributors)! 🙌🏼 + +**_:trophy: 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: +```bash +npm run dev +``` +Open the browser to visit the website at http://localhost:3000 + +--- + +## Style Guide for Git Commit Messages :memo: + +**How you can add more value to your contribution logs:** + +- 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](https://github.com/thecyberworld/thecyberhub.org/issues) and [Pull Requests](https://github.com/thecyberworld/thecyberhub.org/pulls) liberally after the first line. + +--- + +## 💥 Issues + +In order to discuss changes, you are welcome to [open an issue](https://github.com/thecyberworld/thecyberhub.org/issues/new/choose) about what you would like to contribute. Enhancements are always encouraged and appreciated. + +## All the best! 🥇 + +[![built with love](https://forthebadge.com/images/badges/built-with-love.svg)](https://thecyberhub.org) diff --git a/README.md b/README.md index d5f0a39e..7c9adb78 100644 --- a/README.md +++ b/README.md @@ -1 +1,51 @@ -# thecyberworld \ No newline at end of file +# thecyberworld + +

+ thecyberhub: hub of cyber-security. +

+ +![thecyberhub](https://user-images.githubusercontent.com/44284877/180642062-a9a66f83-746c-468e-97a8-707c259a92cd.png) + +

+ 👨‍💻 Website link: + thecyberhub +

+ +--- + +### 👇 Prerequisites + +Before installation, please make sure you have already installed the following tools: +- [Git](https://git-scm.com/downloads) +- [Nodejs](https://nodejs.org/en/download/) + +--- + +### 🛠️ Installation Steps + +1. Fork the project +2. Clone the forked project +3. Navigate to the cloned project directory +4. Install the dependencies with `npm install` +5. Run `npm run dev` to start the server +6. Open the browser to visit the website at http://localhost:3000/ + +--- + +> If you are new to Git and GitHub then must check out **[git-github-practice](https://github.com/thecyberworld/git-github-practice)** repository **first** and contribute to it before you contributing to other open-source projects. + +## 👨‍💻 Contributing + +- Contributions make the open source community such an amazing place to learn, inspire, and create. +- Any contributions you make are **truly appreciated**. +- Check out our [contribution guidelines](/CONTRIBUTING.md) for more information. + +## 🛡️ License + +[thecyberhub.org](https://www.thecyberhub.org) is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## 🙏 Support + +This project needs a ⭐️ from you. Don't forget to leave a star ⭐️ + +--- diff --git a/pull_request_template.md b/pull_request_template.md index cfb15ae3..9dfceaf9 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -42,5 +42,5 @@ Incorrect ways to mark a box: --- You can also join our [Discord](https://discord.gg/QHBPq6xP5p) community.
-Feel free to check out other cool repositories of the [Cryptoverse Web3](https://github.com/CryptoverseWeb3).
+Feel free to check out other cool repositories of the [thecyberhub.org Web3](https://github.com/CryptoverseWeb3).
Join the Cryptoverse Web3 GitHub Organisation by raising an [issue](https://github.com/CryptoverseWeb3/Support/issues/new?assignees=&labels=invite+me+to+the+organisation&template=invitation.yml&title=Please+invite+me+to+the+GitHub+Community+Organization) (you will be sent an invitation).