diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa2cd46de..1b2eff075 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,56 @@ -# Contribute to rtMedia +# Contributing to rtMedia +We love your input! We want to make contributing to rtMedia as easy and transparent as possible, whether it's: -This guide details how to use issues and pull requests to improve rtMedia. +- Reporting a bug +- Discussing the current state of the code +- Submitting a fix +- Proposing new features +- Becoming a maintainer ## Closing policy for issues - Github issue-tracker is used **only** for developer & contributor discussion. - For support-request/feature-request, please use - https://rtmedia.io/support/ -## Translation +## Our Development Process +We use GitHub to host code, to track issues and feature requests, as well as accept pull requests. -Please do NOT send pull-request for translations. +## Flow +Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests: + +1. Fork the repo and create your branch from `pre-release`. +2. Ensure your code doesn't give any errors. Run make before creating the pull request. +3. Add a proper description about the fix. +4. Add reference of the issue in the description. +5. If you've added code that should be tested. +6. Make sure to follow [WordPress coding standards](https://github.com/WordPress/WordPress-Coding-Standards). +7. Issue that pull request! + +Please include your wordpress.org username while sending a pull-request so that we can add you to the contributor's list. + +## Report bugs using Github's [issues](https://github.com/rtmediawp/rtmedia/issues) +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! -You can contribute translations using web-interface here - https://rtmedia.io/translate/projects/rtmedia +## Write bug reports with detail + +**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/Screenshots (possibly including why you think this might be happening, or stuff you tried that didn't work) +- Please include your wordpress.org username so that we can add you to the contributor's list. + +People *love* thorough bug reports. I'm not even kidding. + +## Translation +Please do NOT send pull-request for translations. +You can contribute translations using [web-interface](https://translate.wordpress.org/projects/wp-plugins/buddypress-media/contributors/). -## Pull Requests +## License +By contributing, you agree that your contributions will be licensed under its GNU GPLv2 License. -Please include your wordpress.org username while sending pull-request so that we can add you to contributors list. +## References +This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)