|
1 | | -# The Basics |
2 | | - |
3 | | -### Filing a bug |
4 | | - |
5 | | -Check the [Troubleshooting Page](https://github.com/adobe/brackets/wiki/Troubleshooting) for common |
6 | | -issues with installing & launching Brackets, using Live Preview, etc. |
7 | | - |
8 | | -**For bugs** be sure to search existing issues first. Include steps to consistently reproduce the |
9 | | -problem, actual vs. expected results, and your OS and Brackets version number. |
10 | | -Disable all extensions to verify the issue is a core Brackets bug. |
11 | | -[Read more guidelines for filing good bugs...](https://github.com/adobe/brackets/wiki/How-to-Report-an-Issue) |
12 | | - |
13 | | -**For feature requests** please first check our [feature backlog](http://bit.ly/BracketsBacklog) to |
14 | | -see if it's already there. You can upvote features you'd like to see. |
15 | | - |
16 | | -### Submitting a pull request |
17 | | - |
18 | | -**Before you start coding**, post to the [brackets-dev Google group](http://groups.google.com/group/brackets-dev) |
19 | | -or the [#brackets IRC channel on freenode](http://webchat.freenode.net/?channels=brackets) about what |
20 | | -you're thinking of working on, so you can get early feedback. We don't want you to do tons of work |
21 | | -and then have to rewrite half of it! |
22 | | - |
23 | | -For more on what's expected in a good pull request, see [Contributing Code](#contributing-code) below. |
24 | | - |
25 | | - |
26 | | -# Ways to Contribute |
27 | | - |
28 | | -There are many ways you can contribute to the Brackets project: |
29 | | - |
30 | | -* **Fix a bug** or **implement a new feature** - read on below. |
31 | | -* **[Write a Brackets extension](https://github.com/adobe/brackets/wiki/How-to-write-extensions)** and |
32 | | - tell us about it! |
33 | | -* **Test Brackets** and [report bugs](https://github.com/adobe/brackets/wiki/How-to-Report-an-Issue) |
34 | | - you find. For sample testing steps, see |
35 | | - [Brackets smoke tests](https://github.com/adobe/brackets/wiki/Brackets-Smoke-Tests), |
36 | | - [smoke tests with a local server](https://github.com/adobe/brackets/wiki/Brackets-Server-Smoke-Tests), and |
37 | | - [UI walkthrough steps](https://github.com/adobe/brackets/wiki/Localization-Tests). |
38 | | -* **Write unit tests** for Brackets. |
39 | | -* **Translate** Brackets into other languages (and help keep those translations up to date) - see |
40 | | - [localization README](https://github.com/adobe/brackets/blob/master/src/nls/README.md). |
41 | | -* **Write documentation** and help keep it up to date |
42 | | - (the [How to Use Brackets](https://github.com/adobe/brackets/wiki/How-to-Use-Brackets) intro page |
43 | | - is one example). |
44 | | -* **Try out some [Brackets extensions](https://github.com/adobe/brackets/wiki/Brackets-Extensions)** |
45 | | - and give feedback to their authors. |
46 | | - |
47 | | - |
48 | | -## Where Do I Start? |
49 | | - |
50 | | -To start editing the Brackets code, read **[How to Hack on Brackets](https://github.com/adobe/brackets/wiki/How-to-Hack-on-Brackets)**. |
51 | | -To create your first Brackets extension, check out **[How to Write Extensions](https://github.com/adobe/brackets/wiki/How-to-write-extensions)**. |
52 | | - |
53 | | -Here are some ideas: |
54 | | - |
55 | | -* [Starter bugs](https://github.com/adobe/brackets/issues?labels=starter+bug&state=open) can |
56 | | - provide a good intro to the Brackets code. |
57 | | -* [Extension ideas](https://github.com/adobe/brackets/issues?q=label%3A%22Extension+Idea%22) |
58 | | - are feature requests that we think would be best implemented as an add-on; it's up to the |
59 | | - Brackets community to write them! |
60 | | -* [Starter features](http://bit.ly/BracketsBacklog) are a bit larger in scope. Be sure to discuss |
61 | | - these in the newsgroup before starting. _(To see starter features, click Filter Cards on the |
62 | | - right and then click the green "Starter Feature" label)._ |
63 | | - |
64 | | -Once you're ready to start coding, see the next section, [Contributing Code](#contributing-code). |
65 | | - |
66 | | -**I'm new to JavaScript. How can I contribute to Brackets?** Brackets is a lot more complicated |
67 | | -than the average website that uses JS. Better to start on some JS tutorials (like [Codecademy's](http://www.codecademy.com/tracks/javascript) |
68 | | -or [MDN's](https://developer.mozilla.org/en-US/docs/JavaScript/Getting_Started)) and contribute |
69 | | -in some of the other ways listed above. Testing is a great way to start thinking like a programmer |
70 | | -before you've learned to code! |
71 | | - |
72 | | - |
73 | | -## Contributing Code |
74 | | - |
75 | | -To get started editing the Brackets code, read [How to Hack on Brackets](https://github.com/adobe/brackets/wiki/How-to-Hack-on-Brackets). |
76 | | - |
77 | | -Before submitting any pull request, please make sure to: |
78 | | - |
79 | | -1. Discuss any major changes or questions beforehand in the [brackets-dev newsgroup](http://groups.google.com/group/brackets-dev). |
80 | | -2. Consider whether your change would be better as an optional extension. Brackets is lightweight |
81 | | - and tightly focused - but highly extensible. |
82 | | -3. Follow the [Pull Request Checklist](https://github.com/adobe/brackets/wiki/Pull-Request-Checklist) |
83 | | - to ensure a good-quality pull request. |
84 | | -4. Sign the [Brackets Contributor License Agreement](http://dev.brackets.io/brackets-contributor-license-agreement.html) |
85 | | - (we cannot merge before this). |
86 | | - |
87 | | -High quality code and a top-notch user experience are very important in Brackets, and we carefully |
88 | | -review pull requests to keep it that way. The better you follow the guidelines above, the more likely |
89 | | -we are to accept your pull request - and the faster the code review will go. |
90 | | - |
91 | | - |
92 | | -## The Code Review Process |
93 | | - |
94 | | -Brackets committers are responsible for reviewing all pull requests, providing feedback, and |
95 | | -ultimately merging good code into `master`. The review process ensures all code is high quality, |
96 | | -maintainable, and well documented. |
97 | | - |
98 | | -Once you've opened a pull request, a committer will generally respond to it within a week with an |
99 | | -initial set of comments (you don't need to ping anyone to find a reviewer). Some pull requests |
100 | | -raise larger questions about UI design, product scope or architecture. Those are tagged to indicate |
101 | | -that review will take longer: |
102 | | - |
103 | | -* \[PM\] - needs high-level input from product management |
104 | | -* \[XD\] - needs UI design / visual design discussion |
105 | | -* \[ARCH\] - needs architectural discussion |
106 | | - |
107 | | -The best way to avoid this sort of holdup is to discuss your changes on the newsgroup first! |
108 | | - |
109 | | -Once your pull request is merged, it will appear in the next release of Brackets - generally within |
110 | | -two weeks. |
111 | | - |
112 | | -**Interested in becoming a committer?** See the [Committer Policy](https://github.com/adobe/brackets/wiki/Brackets-Committer-Policy) |
113 | | -for details. Committers are expected to take a leading role in the project by making significant |
114 | | -code contributions, reviewing pull requests, and providing feedback and suggestions on the |
115 | | -direction of the project. |
116 | | - |
117 | | -Even if you're not a committer, you're still welcome to give feedback on any pull request! |
| 1 | +# Contributing to Open Research |
| 2 | +:+1::tada: Thanks for taking the time to contribute! :tada::+1: |
| 3 | +## Table of Contents |
| 4 | +1. [About the Project](#about-the-project) |
| 5 | +1. [Project Status](#project-status) |
| 6 | +1. [Getting Started](#getting-started) |
| 7 | + |
| 8 | +## Community engagement |
| 9 | +1. [Code of Conduct](https://github.com/phcode-dev/phoenix/blob/main/CODE_OF_CONDUCT.md) |
| 10 | +1. [License](https://github.com/phcode-dev/phoenix/blob/main/LICENSE) |
| 11 | +### Need support? |
| 12 | +* Log an issue with us [here](https://github.com/phcode-dev/phoenix/issues/new/choose) |
| 13 | +### Engage with the community? |
| 14 | +* Discuss the project [here](https://github.com/phcode-dev/phoenix/discussions) |
| 15 | +* Join our community discord channel [here](https://discord.com/invite/rBpTBPttca). |
| 16 | + |
| 17 | +# About the Project |
| 18 | +Documentation for phoenix/brackets |
| 19 | + |
| 20 | +## Project Status |
| 21 | +* Active. |
| 22 | + |
| 23 | +# Getting Started |
| 24 | +* see https://github.com/phcode-dev/phoenix/blob/main/README.md |
0 commit comments