Showing content from https://github.com/adobe/brackets/wiki/Pull-Request-Checklist below:
Pull Request Checklist · adobe/brackets Wiki · GitHub
High quality code and a top-notch user experience are very important in Brackets, and we carefully review pull requests to keep it that way. Here's what we expect of a good quality pull request — be sure to follow all these items for a smooth landing!
Note: you must sign the Brackets Contributor License Agreement before we can merge your first pull request.
###Pull Request Checklist
- Discuss any major architectural or UI changes in the brackets-dev newsgroup
- Does this change belong in Brackets core? Some features would be better as an extension — which may require factoring out a generic set of core API changes to enable writing the extension. When in doubt discuss in the newsgroup
- Code follows our JS coding style guidelines
- Code is well documented, including Closure-style type annotations
- Code passes JSLint
- Testing
- Code has been tested — in your pull request, describe the cases you tested
- No known bugs
- All unit tests pass ... (Debug > Run Tests)
- [Smoke tests](Brackets Smoke Tests) pass (for larger, cross-cutting changes)
- Include unit tests for new functionality
- Avoid breaking API changes — existing public APIs are not strictly frozen, but you'll need a good reason for breaking backwards compatibility. The more commonly-used the API, the stronger the reason needed
- All user-visible strings are externalized
- Note: there's a "string freeze" near the end of each sprint. Pending pull requests with string changes must wait until the start of the next sprint.
- UI is reasonably polished
- After merging, all new & changed APIs should be documented in the Release Notes
(See also the Pull Request Review Checklist that committers follow when doing the code review)
###Common Pitfalls
To avoid problems, consider whether any of these apply to your pull request:
- Text editing commands: what happens at the edges of an inline editor? (not just the edges of the overall document)
- Inline editors: does this collide with any other Quick Edit providers?
- Code hinting: does this collide with any other hint providers?
- Live Preview: ensure [Server smoke tests](Brackets Server Smoke Tests) pass
- Native code (brackets-shell): must include implementations for Mac, Windows and Linux
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4