Add contribution guide
This commit is contained in:
parent
1eb44b8308
commit
9a41fced7e
|
@ -18,7 +18,7 @@ Steps to reproduce the behavior:
|
|||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
Provide commands or configuration file if possible.
|
||||
Provide commands, Mattermost and PHP logs or configuration file if possible.
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
@ -28,11 +28,11 @@ If applicable, add screenshots to help explain your problem.
|
|||
|
||||
**Project (please complete the following information):**
|
||||
|
||||
- Project Version: (e.g. version 0.4.0)
|
||||
- Project Version: (e.g. version v1.1)
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
|
||||
- OS: (e.g. iOS)
|
||||
- OS: (e.g. Fedora)
|
||||
- Browser (e.g. chrome, safari)
|
||||
- Version (e.g. 22)
|
||||
|
||||
|
|
|
@ -18,4 +18,4 @@ A clear and concise description of what you want to happen.
|
|||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
Add any other context or screenshots/diagram about the feature request here.
|
||||
|
|
|
@ -2,9 +2,9 @@
|
|||
|
||||
Some key notes before you open a PR:
|
||||
|
||||
1. Select which branch should this PR be merged in? By default, you should always merge to the develop branch.
|
||||
1. Select which branch should this PR be merged in? By default, you should always merge to the develop branch (master).
|
||||
2. PR name follows [convention](http://karma-runner.github.io/4.0/dev/git-commit-msg.html)
|
||||
3. All tests pass locally, UI and Unit tests
|
||||
3. All tests pass locally, at least the Demo `docker-compose.yaml` is working.
|
||||
4. All business logic and validations must be on the server-side
|
||||
5. Update necessary Documentation
|
||||
6. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes
|
||||
|
@ -24,6 +24,6 @@ Also, if you're new here
|
|||
|
||||
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
|
||||
|
||||
> Screenshots/GIFs
|
||||
> Optional : Screenshots/Schema
|
||||
|
||||
<!-- Add images/recordings to better visualize the change: expected/current behviour -->
|
||||
|
|
|
@ -0,0 +1,52 @@
|
|||
# Contributing to Transcriptase
|
||||
|
||||
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
|
||||
|
||||
- Reporting a bug
|
||||
- Discussing the current state of the code
|
||||
- Submitting a fix
|
||||
- Proposing new features
|
||||
- Becoming a maintainer
|
||||
|
||||
## We Develop with Github
|
||||
|
||||
We use github to host code, to track issues and feature requests, as well as accept pull requests.
|
||||
|
||||
## We use [Github Flow](https://guides.github.com/introduction/flow/index.html), So all code changes happen through Pull Requests
|
||||
|
||||
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
|
||||
|
||||
1. Fork the repo and create your branch from `master`.
|
||||
2. If you've added code that should be tested, add tests.
|
||||
3. Update the documentation.
|
||||
4. Ensure the test suite passes. At least, your PR must work with Demo `docker-compose`.
|
||||
5. Make sure your code lints.
|
||||
6. Issue that pull request!
|
||||
|
||||
## Any contributions you make will be under the MIT Software License
|
||||
|
||||
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](https://github.com/Crivaledaz/Mattermost-LDAP/blob/master/LICENSE) that covers the project. Feel free to contact the project owner if that's a concern.
|
||||
|
||||
## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
|
||||
|
||||
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/Crivaledaz/Mattermost-LDAP/issues/new/choose); it's that easy!
|
||||
|
||||
## Write bug reports with detail, background, and sample code
|
||||
|
||||
**Great Bug Reports** tend to have:
|
||||
|
||||
- A quick summary and/or background
|
||||
- Steps to reproduce
|
||||
- Be specific!
|
||||
- Give sample code if you can.
|
||||
- What you expected would happen
|
||||
- What actually happens
|
||||
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
|
||||
|
||||
## License
|
||||
|
||||
By contributing, you agree that your contributions will be licensed under its MIT License.
|
||||
|
||||
## References
|
||||
|
||||
This document was adapted from the [briandk/CONTRIBUTING.md Gist](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62)
|
Loading…
Reference in New Issue