Skip to content

How to contribute ?

FAK edited this page Nov 13, 2024 · 6 revisions

We appreciate your interest in contributing to the Cyber Library! Here’s how to get started with contributing:

Prerequisites

  • Git installed on your local machine.
  • A GitHub account.
  • Familiarity with Markdown.

Contribution Steps

  1. Fork the Repository

    • Navigate to the top right of this repository and click the Fork button to create a copy in your GitHub account.
  2. Clone Your Fork

    • Clone the repository to your local machine using the following command:
      git clone https://github.com/<yourusername>/cyber-library.git
      cd cyber-library
  3. Create a New Branch from development

    • Before making any changes, create a new branch from development:
      git checkout -b <branch_name> origin/development
  4. Make Your Changes

    • Add or modify markdown files as necessary.
  5. Commit and Push Your Changes

    • Stage and commit your changes:
      git add .
      git commit -m "Add/update [topic]"
    • Push your changes to your forked repository:
      git push origin your-branch-name
  6. Open a Pull Request (PR)

    • Open a Pull Request from your branch to the development branch in the main repository.

Need help ?

For more information, you can reach out via our Discord server or use any of the following references:

Clone this wiki locally