docs: moved contribution guidelines to a separate file

This commit is contained in:
Jannat Patel
2021-10-27 20:08:26 +05:30
parent 1f6bdfbaa0
commit a01c80794c
2 changed files with 11 additions and 9 deletions

7
Contribution.md Normal file
View 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.

View File

@@ -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