docs: moved contribution guidelines to a separate file
This commit is contained in:
7
Contribution.md
Normal file
7
Contribution.md
Normal file
@@ -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.
|
||||||
13
README.md
13
README.md
@@ -6,8 +6,8 @@ Create online courses without much hassle.
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
1. Create online courses in a simple manner
|
1. Simple Backend Forms.
|
||||||
1. The UI is clean and minimal
|
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.
|
1. Lessons can be in the form of texts, videos, quizzes or a combination of all of these.
|
||||||
|
|
||||||
## Development Setup
|
## Development Setup
|
||||||
@@ -16,14 +16,9 @@ Create online courses without much hassle.
|
|||||||
1. [Direct install through bench](bench-installation.md)
|
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. [Contribution Guidelines](Contribution.md)
|
||||||
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.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user