apple_cursor/CONTRIBUTING.md

57 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

2020-08-07 22:45:13 -04:00
# Contributing to Apple Cursor
I love your input! I 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
## I Develop with Github
I use GitHub to host code, to track **issues** and feature requests, as well as accept **pull requests**.
## I 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 (I use [Github Flow](https://guides.github.com/introduction/flow/index.html)). I actively welcome your pull requests:
2020-10-01 00:38:10 -04:00
1. Fork the repo and create your branch from `main`.
2020-08-07 22:45:13 -04:00
2. If you've added code that should be tested, add tests.
3. If you've changed Look, update the documentation.
4. Issue that pull request!
## Any contributions you make will be under the GPL-3.0 Software License
In short, when you submit code changes, your submissions are understood to be under the same [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.en.html) that covers the project. Feel free to contact the maintainers if that's a concern.
## Report bugs using Github's [issues](https://github.com/ful1e5/apple_cursor/issues)
I use GitHub issues to track public bugs. Report a bug by opening a new issue, 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)
People _love_ thorough bug reports. I'm not even kidding.
## License
By contributing, you agree that your contributions will be licensed under its `GPL-3.0` License.
## 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)
## Contributors
Become first contributor. 🤗