Skip to content

Latest commit

 

History

History
153 lines (95 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

153 lines (95 loc) · 3.61 KB
Raw

Contributing to Oju's Blogs

Thank you for your interest in contributing to Oju's Blogs! We welcome all types of contributions and appreciate your help in making this project better.

How to Contribute

To contribute to Oju's Blogs, please follow these steps:

  1. Fork the repository

    First, fork the repository by clicking the "Fork" button at the top right corner of the GitHub page. This creates a copy of the repository under your GitHub account.

  2. Clone the Forked Repository

    Clone your forked repository to your local machine using the following command in your Git Bash terminal:

    git clone git@github.com:your-username/Oju-s-Blogs.git

  3. Project Setup

  • Open the Clone Repo folder
   cd repo_name

  • Run Back End.

    • Navigate to Backend folder.
    cd Backend
    • Install Dependencies.
     npm i
    • Run Back End Using.
    npm start

  • Run Front End.

    • Navigate to Frontend folder.
    cd Frontend/frontend
    • Install Dependencies.
     npm i
    • Run Front End Using.
    npm start

  1. Make your changes

1. Add a reference (remote) to the original repository.

git remote add upstream https://github.com/ojasaklechayt/Oju-s-Blogs.git

2. Check the remotes for this repository.

git remote -v

3. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).

git pull upstream main

4. Create a new branch.

git checkout -b pr1

5. Search the "issue-finder" folder, add the modified HTML and CSS files and remove the previous ones.

6. Track your changes.✔️

git add .

7. Commit your changes.

git commit -m "pulled my first PR"

8. Push the committed changes in your feature branch to your remote repository.

git push origin pr1

9. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.

10. Add appropriate title, description and screenshots to your pull request explaining your changes and efforts done.

11. Click on Create Pull Request.

12. Voila! You have made a PR to the project. Sit back and relax while your PR is reviewed by the maintainers.

  1. Submit a pull request

    • Before making any PR please create an Issue
    • If you find any upgradation or bug in the website, you can create your own issue or work on the previous issues.
    • When creating PR make sure you tag the required issue using # issuenumber Happy Coding!!

Your First Code Contribution

If you are making your first code contribution, please follow these guidelines:

  • Make sure to read the README.md file to understand the project structure and requirements
  • Use clear and concise commit messages
  • Follow the styleguides for code and documentation

Improving the Documentation

If you want to improve the documentation, please follow these guidelines:

  • Use clear and concise language
  • Make sure to include all necessary information
  • Follow the styleguides for documentation

Styleguides

Please follow these styleguides when contributing to Oju's Blogs:

  • Use clear and concise language
  • Follow the appropriate language-specific style guide, such as the Google Style Guides, to maintain consistency in your code.
  • Use SemVer for versioning