|
|
| (47 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| <p>This page is under heavy development. Here is the [[Dev Chat]] page, which is being incorporated into this Issues portal.</p>
| |
| <p> </p> | | <p> </p> |
| <hr />
| | <h2>Step 1 - Research</h2> |
| <p> </p>
| | <h3>Resources</h3> |
| <p><em>Did you find a bug?</em></p>
| |
| <p><em>Is there a usability issue?</em></p>
| |
| <p><em>Do you have a great feature idea to share?</em></p>
| |
| <p><em><br /></em></p>
| |
| <p><strong>Development Protocol</strong></p>
| |
| <ul>
| |
| <li>We are a global community with a great diversity of opinions and potential. Always be respectful!</li>
| |
| <li>Both devs and players are very busy: following a protocol is a matter of professionalism.</li>
| |
| <li>This protocol will help you contribute to development in an effective and orderly fashion.</li>
| |
| </ul>
| |
| <p> </p>
| |
| <h2>RESEARCH</h2> | |
| <h3>How?</h3> | |
| <h5>Look it up!</h5>
| |
| <ul> | | <ul> |
| <li>Before posting to the community, please first research existing resources.</li> | | <li>[http://eternawiki.org/wiki/index.php5/Main_Page EteRNA Wiki] links to many guides that could help answer your question.</li> |
| <li>Poorly researched posts could be misunderstood, ignored, or deleted.</li>
| |
| </ul> | | </ul> |
| <h5>Resources</h5> | | <h3>Describe</h3> |
| <ul> | | <ul> |
| <li>Has the issue already has been reported, or even resolved?</li> | | <li>[[Issue Template]] can be used to outline key issue details.</li> |
| <li>Find potential solutions to an unresolved issue!</li>
| |
| </ul> | | </ul> |
| <h5>Understand</h5>
| |
| <ul> | | <ul> |
| <li>Be prepared to describe each key point of the issue.</li>
| |
| <li>Take notes on any details, screenshots, or links that help explain the issue.</li>
| |
| </ul> | | </ul> |
| <p> </p> | | <p> </p> |
| <h3>Where?</h3> | | <h2>Step 2 - Communicate</h2> |
| <h5>Wiki</h5> | | <h3>Chat</h3> |
| <ul> | | <ul> |
| <li>[http://eternawiki.org/wiki/index.php5/Main_Page EteRNA Wiki]</li> | | <li>[http://eterna.cmu.edu/web/ EteRNA Chat] is great for quick questions. Always be courteous! :)</li> |
| <li>Browse, or use the Search field at the left bottom of the screen. Do not post yet, just research!</li>
| |
| </ul> | | </ul> |
| <h5>Forums</h5> | | <h3>Forums</h3> |
| | <div> |
| <ul> | | <ul> |
| <li>[https://getsatisfaction.com/eternagame EteRNA Forums]</li> | | <li>[https://getsatisfaction.com/eternagame EteRNA Forums] is where you can post details & screenshots for the community to discuss.</li> |
| <li>Browse, use the Search field at the top right, or use the "Ask a question" box in the top center of the screen. Do not post yet, just research!</li>
| |
| </ul> | | </ul> |
| <h5>GitHub</h5>
| |
| <ul> | | <ul> |
| <li>[https://github.com/EteRNAgame/EteRNA-public/issues EteRNA GitHub]</li>
| |
| <li>Browse, or use the Search field at the top left-center. Do not post! Players do not have GitHub access at this time.</li>
| |
| </ul>
| |
| <p> </p>
| |
| <h2>BRAINSTORM</h2>
| |
| <h3>How?</h3>
| |
| <h5>Friendly</h5>
| |
| <ul>
| |
| <li>Players are very busy and have responsibilities outside of the game. Always be kind, patient, and respectful! </li>
| |
| <li>It is each of our responsibility to preserve the friendly community attitude, so that we all continue to be inspired to help each other. Remember, we're all in this together! :)</li>
| |
| </ul>
| |
| <h5>Feedback</h5>
| |
| <ul>
| |
| <li>The community is very knowledgeable, and provides the benefit of years of experience. We can share key details about the Issue that help to understand how to proceed effectively.</li>
| |
| <li>If we cannot answer the question directly, often we can at least point in the right direction by specifying links to specific resources and Forum discussions that may help.</li>
| |
| </ul>
| |
| <h5>Collaboration</h5>
| |
| <ul>
| |
| <li>In addition to receiving feedback, reaching out to the community allows us to actively discuss and brainstorm solutions that we might not have thought of alone.</li>
| |
| <li>Don't forget the conversation goes both ways! The more you participate and help others with their Issues, the more they will be inspired to help you.</li>
| |
| </ul> | | </ul> |
| | </div> |
| <p> </p> | | <p> </p> |
| <h3>Where?</h3> | | <h2>Step 3 - Track</h2> |
| <h5>Chat</h5>
| |
| <ul>
| |
| <li>[http://eterna.cmu.edu/web/ EteRNA Chat]</li>
| |
| <li>Login or Register at the bottom left, and then you can Post in Chat, which is accessible at the top right after logging in.</li>
| |
| <li>Respect that players are busy and may not see the question, or know the answer at this time. You can try Chat again later, or to preserve the Issue create a Post in the Forums instead. ( see below )</li>
| |
| </ul>
| |
| <h5>Groups</h5>
| |
| <ul>
| |
| <li>[http://eterna.cmu.edu/web/group/ EteRNA Groups]</li>
| |
| <li>Login or Register at the bottom left, and then you can Search, Browse, Follow, Subscribe, and Create Groups through the Community -> Groups menu at the top of the page.</li>
| |
| <li>Be patient and keep in mind that the global community spans all time zones. Some Groups are open registry, while others are invite only. If you are nice and do not spam, you will make friends easily! </li>
| |
| </ul>
| |
| <h5>Forums</h5>
| |
| <ul>
| |
| <li>[https://getsatisfaction.com/eternagame EteRNA Forums]</li>
| |
| <li>Login at the top right ( requires EteRNA Registration, see above ), and then you can Post in the Forums using the "Share an idea", "Report a problem", or "Give praise" tabs box in the top center of the screen.</li>
| |
| <li>The Forums provide a central whiteboard to post Issue descriptions, images, and links. This provides a record of the Issue that we all can refer to at any time, unlike Chat which disappears quickly.</li>
| |
| </ul>
| |
| <p> </p>
| |
| <h2>DEFINE</h2>
| |
| <h3>How?</h3>
| |
| <p> </p>
| |
| <ul>
| |
| <li><strong>DETAILS</strong>: Preliminary research & discussion filters out redundancy, and allows for collaboration / shared wisdom that could change critical details of the issue, or potentially resolve it without ever filing it in GitHub.</li>
| |
| </ul>
| |
| <ul>
| |
| <li><strong>COMPREHENSION</strong>: Remember, Forums and Dev Chat are for discussion, GitHub is not. By the time an issue gets to GitHub it must be fully understood and vetted.</li>
| |
| </ul>
| |
| <div> | | <div> |
| <ul> | | <ul> |
| <li>Please use this [[Dev Chat]] portal here on the Wiki to formally outline player requests and set priority.</li>
| |
| </ul> | | </ul> |
| </div> | | </div> |
| | <h3>Development Status</h3> |
| | <div> |
| <ul> | | <ul> |
| <li>diagnose</li> | | <li>[[New Issues]] is where players track issues.</li> |
| <li> the forums preserve the discussion, which is indispensible for reference during the following stages of development. </li>
| | <li>[[Dev Chat]] is where players and devs discuss issues.</li> |
| </ul>
| | <li><span style="font-size: 10px;">[[Website Deployment History]] is where devs post release notes on resolved issues.</span></li> |
| <p> </p>
| |
| <p> </p>
| |
| <h3>Where?</h3>
| |
| <ul>
| |
| <li>forum</li> | |
| <li>WIKI:</li>
| |
| <li>dev chat </li>
| |
| </ul>
| |
| <p> </p>
| |
| <h2>TRACK</h2>
| |
| <p><strong>Issue Tracking</strong>: Once a bug or feature has been approved for exploration during Dev Chat, it will be entered into GitHub. If there is an additional tracking mechanism, it should be updated here. Stay tuned for incoming updates on this matter!</p>
| |
| <p>Rhiju is looking into whether players can edit the existing EteRNA GitHub instance directly, or whether the devs prefer to branch out a separate player-level GitHub instance. Either way, soon we hope to have a more robust tracking system that will enable proper tagging & tracking of issues so that nothing gets missed.</p>
| |
| <p>When a GitHub instance becomes available for final-stage tracking of issues, GitHub will take over the role of formal filing & tracking of issues, and then this wiki Issues portal will function only for the preliminary stages of issue tracking.</p>
| |
| <p>Please note that even when we get the awesome power that is GitHub, DO NOT skip the preliminary stages of issue exploration! The preliminary stages of understanding an issue are just as important as the actual filing of the issue with the dev team. Why? Another good question!</p>
| |
| <ul>
| |
| <li><strong>ORDER</strong>: Ever wonder what happened to that random suggestion that flew by in chat? Or that issue that keeps popping up in the forums? Following a protocol ensures you know where to look for what, and when.</li>
| |
| <li><strong>FOCUS</strong>: It may seem like a good idea to plug every possible issue directly into GitHub, but I assure you this will only overwhelm the devs with tedium, and it will be that much harder for them to focus on fixing the bugs and features that are most important.</li>
| |
| </ul>
| |
| <p> </p>
| |
| <h3>How?</h3>
| |
| <p> </p>
| |
| <h3>Where?</h3>
| |
| <ul>
| |
| <li><span style="white-space: pre;">G</span>ITHUB: </li> | |
| </ul>
| |
| <h2>ARCHIVE</h2>
| |
| <p> </p>
| |
| <h3>How?</h3>
| |
| <p> </p>
| |
| <h3>Where?</h3>
| |
| <ul>
| |
| <li>WIKI: </li>
| |
| </ul>
| |
| <p> </p>
| |
| <div id="_mcePaste" class="mcePaste" style="position: absolute; left: -10000px; top: 1137px; width: 1px; height: 1px; overflow: hidden;">
| |
| <h5>Respect</h5>
| |
| <ul>
| |
| <li>Following a protocol is a matter of professionalism. Both devs and players are very busy, and .</li>
| |
| <li>We all have sparks of ingenuity, followed by the sobering requirements of actually manifesting a solution. When we take the time to ..., we show respect to our fellow colleagues.</li>
| |
| </ul> | | </ul> |
| </div> | | </div> |
| <div id="_mcePaste" class="mcePaste" style="position: absolute; left: -10000px; top: 1137px; width: 1px; height: 1px; overflow: hidden;"> | | <div><ol> </ol> |
| <ul> | | <ul> |
| </ul> | | </ul> |
| </div> | | </div> |
