From a01c80794c895784e1de7a37465c0b778603cbe4 Mon Sep 17 00:00:00 2001 From: Jannat Patel Date: Wed, 27 Oct 2021 20:08:26 +0530 Subject: [PATCH] docs: moved contribution guidelines to a separate file --- Contribution.md | 7 +++++++ README.md | 13 ++++--------- 2 files changed, 11 insertions(+), 9 deletions(-) create mode 100644 Contribution.md diff --git a/Contribution.md b/Contribution.md new file mode 100644 index 00000000..ce403717 --- /dev/null +++ b/Contribution.md @@ -0,0 +1,7 @@ + +1. Go to the apps/school directory of your installation and execute git pull --unshallow to ensure that you have the full git repository. Also fork the frappe/school repository on GitHub. +1. Check out a working branch in git (e.g. git checkout -b my-new-branch). +1. Make your proposed changes to the source +1. Run your local version (e.g. bench start in your bench installation). Make sure that your changes work the way you want them to. +1. Commit your changes to your branch. Make sure to use a semantic commit message. +1. Push your branch to your fork on Github, and issue a pull request. diff --git a/README.md b/README.md index 5113c922..12718f16 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ Create online courses without much hassle. ## Features -1. Create online courses in a simple manner -1. The UI is clean and minimal +1. Simple Backend Forms. +1. The UI is clean and minimal. 1. Lessons can be in the form of texts, videos, quizzes or a combination of all of these. ## Development Setup @@ -16,14 +16,9 @@ Create online courses without much hassle. 1. [Direct install through bench](bench-installation.md) -### Contribution Guidelines +### Contributing -1. Go to the apps/school directory of your installation and execute git pull --unshallow to ensure that you have the full git repository. Also fork the frappe/school repository on GitHub. -1. Check out a working branch in git (e.g. git checkout -b my-new-branch). -1. Make your proposed changes to the source -1. Run your local version (e.g. bench start in your bench installation). Make sure that your changes work the way you want them to. -1. Commit your changes to your branch. Make sure to use a semantic commit message. -1. Push your branch to your fork on Github, and issue a pull request. +1. [Contribution Guidelines](Contribution.md) ## License