Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

86 lines (54 loc) · 2.26 KB

How to Contribute to this Project

Clone the project

git clone https://github.com/zuri-training/team-15_my-cms.git

Go to the project directory

cd team-15_my-cms
Run Locally

Preferred tool for creating and managing virtual environments: pipenv (see installation guide: https://pypi.org/project/pipenv/).

Create a virtual environment and install needed dependencies in it

pipenv install

Activate the virtual environment

pipenv shell

Create a .env file in the same directory as the settings.py (config folder) with the following contents:

Don't enclose the secret key in any quotation mark.

SECRET_KEY=<your-secret-key>

Generate a secret key from https://djecrety.ir/.

If you'll just be working on the front-end, therunning locallysection is optional. All your HTML, CSS, and JavaScript files should go into the frontend directory.

Create a branch to make your changes to.

git branch <your-github-username_feature>

Switch into your branch

git checkout <your-github-username_feature>

Set Upstream branch

git push --set-upstream origin <your-github-username_feature>

Commit and push your changes to your branch.

  git add . || git add --all || git add -A
  git commit -m <commit-message>
  git push

You can also just fork the repository and make your changes to that fork.

Create a pull request on the GitHub Repository. Learn How.

Request a review for your pull request from @jeremy0x and @chidiarua.

Your changes will be merged into the main branch when they are approved by the reviewers.