MSFTMPP-594: Updated plugin READMEs to add support expand contributing sections
This commit is contained in:
Родитель
96ab51ed2c
Коммит
c41ace0786
36
README.md
36
README.md
|
@ -9,7 +9,7 @@ This is part of the suite of Office 365 plugins for Moodle.
|
|||
|
||||
This repository is updated with stable releases. To follow active development, see: https://github.com/Microsoft/o365-moodle
|
||||
|
||||
## Installation.
|
||||
## Installation
|
||||
|
||||
1. Unpack the plugin into /blocks/microsoft within your Moodle install.
|
||||
2. From the Moodle Administration block, expand Site Administration and click "Notifications".
|
||||
|
@ -18,13 +18,41 @@ This repository is updated with stable releases. To follow active development, s
|
|||
|
||||
For more documentation, visit https://docs.moodle.org/30/en/Office365
|
||||
|
||||
# Contributing
|
||||
## Support
|
||||
|
||||
Before we can accept your pull request, you'll need to electronically complete Microsoft's [Contributor License Agreement](https://cla.microsoft.com/). If you've done this for other Microsoft projects, then you're already covered.
|
||||
If you are experiencing problems, have a feature request, or have a question, please open an issue on Github at https://github.com/Microsoft/o365-moodle.
|
||||
|
||||
To help developers debug problems, please include the following in all issues:
|
||||
- Plugin versions.
|
||||
- Moodle version.
|
||||
- Detailed instructions of what went wrong and how to reproduce the problem.
|
||||
- Any error messages encountered.
|
||||
- PHP version.
|
||||
- Database software and versions.
|
||||
- Any other environmental information available.
|
||||
|
||||
Note that developers will triage issues and deal with more serious problems first. All issues will be addressed but some may not be addressed immediately.
|
||||
|
||||
## Contributing
|
||||
|
||||
We're looking for community contributions! Feel free to submit pull requests, but please do so against the development repository at https://github.com/Microsoft/o365-moodle. Pull requests submitted to individual plugin repositories cannot be accepted.
|
||||
|
||||
### Needed Contributions
|
||||
Smaller issues that developers cannot address right away will be labeled with "Help Wanted" in the issue tracker in the development repository at https://github.com/Microsoft/o365-moodle/issues. These are only suggestions - we can also accept pull requests fixing other bugs, or even adding new features.
|
||||
|
||||
Pull requests adding new features are much appreciated but note that they may be rejected (even if technically sound) if they do not match the direction of the project. If you want to add a new feature, it's best to open an issue outlining your idea first, and get feedback from the maintainers.
|
||||
|
||||
Contributions to our documentation are especially appreciated! All documentation lives in the /local/o365docs folder of the development repository (https://github.com/Microsoft/o365-moodle). Updates to this documentation can be sent via pull request like any other contributions.
|
||||
|
||||
### Code Review
|
||||
All pull requests go through a thorough examination from developers before they are merged. Please read our [code review process](https://github.com/Microsoft/o365-moodle/tree/master/local/o365docs/codereview.md) and ensure your code is consistent before submitting. A developer may respond with changes that are needed before a pull request can be accepted and it is up to the submitter to make those changes. If accepted, your commit will remain as-is to ensure you get credit, but developers may modify solutions slightly in subsequent commits.
|
||||
|
||||
### CLA
|
||||
Finally, before we can accept your pull request, you'll need to electronically complete Microsoft's [Contributor License Agreement](https://cla.microsoft.com/). If you've done this for other Microsoft projects, then you're already covered.
|
||||
|
||||
[Why a CLA?](https://www.gnu.org/licenses/why-assign.html) (from the FSF)
|
||||
|
||||
# Copyright
|
||||
## Copyright
|
||||
|
||||
© Microsoft, Inc. Code for this plugin is licensed under the GPLv3 license.
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче