Skip to content

contributing.md

Latest commit

 

History

History
131 lines (92 loc) · 4.27 KB

contributing.md

File metadata and controls

131 lines (92 loc) · 4.27 KB

Contributing to DevNation CMS

Welcome to DevNation CMS! We're excited that you're interested in contributing to our project. This guide will walk you through the process of contributing to our repository.

DevNation CMS Logo

Table of Contents

How to Contribute

1. Star the Repository

Before you start contributing, please star our repository to show your support!

Star the repository

2. Fork the Repository

  1. Navigate to the DevNation CMS repository.

  2. Click on the "Fork" button in the top-right corner of the page.

    Fork option

  3. Give your forked repository a name and description (optional).

  4. Click on "Create fork".

    Create fork

3. Clone the Repository

  1. Go to your forked repository on GitHub.
  2. Click on the "Code" button and copy the HTTPS URL.
  3. Open your terminal and run: 
    git clone https://github.com/your-username/DevNation-CMS.git

4. Create a New Branch

  1. Change to the repository directory on your computer: 
    cd DevNation-CMS
  2. Create a new branch using: 
    git checkout -b your-branch-name

5. Make Changes

  1. Open the project in your preferred code editor.
  2. Make the necessary changes or additions to the codebase.

6. Commit Your Changes

  1. Stage your changes: 
    git add .
  2. Commit your changes: 
    git commit -m "Brief description of your changes"

7. Push Changes to GitHub

Push your changes to your forked repository:

git push origin your-branch-name

8. Create a Pull Request

  1. Go to your forked repository on GitHub.

  2. Click on "Compare & pull request".

  3. Important: Ensure that your pull request does not contain spam.

  4. Add a title and description for your pull request.

  5. Label the issue tags for all pull requests.

  6. If no relevant issues exist, create a new issue related to your pull request.

  7. Click on "Create pull request".

    Create a Pull Request

9. Wait for Review

Wait for the maintainers to review your pull request. They may ask for changes or merge it directly.

Raising an Issue

If you find a bug or have a suggestion for improvement:

  1. Go to the "Issues" tab in the repository.

    Issues tab

  2. Click on "New issue".

    New issue

  3. Add a descriptive title and detailed description of the issue.

  4. Click on "Submit new issue".

Adding a File

  1. Navigate to the appropriate directory in the repository.
  2. Click on "Add file" > "Create new file" or "Upload files".
  3. If creating a new file, name your file and add its content.
  4. If uploading, drag and drop or select files from your computer.
  5. Add a commit message describing your changes.
  6. Click on "Commit new file" or "Commit changes".

Running the Laravel Server

To run the Laravel server on your laptop, please check the appropriate README.md for instructions on running.Setup.md Prerequisites, and troubleshooting errors.

Thank you for contributing to DevNation CMS! Your efforts help make our project better for everyone.