├── CONTRIBUTING.md └── README.md /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | ### Important: 2 | 3 | If you find a potential exploit or vulnerability, please exercise reasonable disclosure: 4 | 5 | 1. Privately [contact Overcast Network staff](mailto:support@oc.tc?subject=Important%20security%20vulnerability) about the issue. 6 | 2. **Do not** publicly disclose the issue immediately (give Overcast Network staff adequate time to respond to and address your inquiry before you disclose the vulnerability publicly). 7 | 8 | ## Submitting 9 | 10 | ### Do: 11 | 12 | * Search the issue tracker to ensure that your issue is not a duplicate 13 | * Verify the validity and/or plausibility of your issue 14 | * Be clear and concise in your description 15 | * Take advantage of [GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/)--it's awesome, and it makes your submission that much better! :smile: 16 | 17 | ### Do not: 18 | 19 | * Bump issues to receive a response (all issues are acknowledged) 20 | * Argue unproductively in an issue's comments 21 | * Re-create an issue you feel unjustly closed 22 | * Add comments such as :+1:, +1 or "I like this idea" 23 | * Submit issues that are general suggestions, as opposed to *specific, technical* bugs or *confirmed* features 24 | * Create disrespectful or inflammatory comments 25 | 26 | ## Formatting 27 | 28 | It is recommended that issues are formatted using the following template for maximum clarity and readability: 29 | 30 | ### Title 31 | 32 | Provide a brief summary of the issue. Your title should allow users browsing the tracker to grasp the gist of your issue at a glance. 33 | 34 | **Example**: 35 | 36 | > Avatars not displaying correctly in friends list 37 | 38 | ### Description 39 | 40 | Try to separate your description into three different sections, if possible: 41 | 42 | 1. **The issue** 43 | 44 | This section should provide a detailed explanation of the issue. 45 | 46 | 2. **Steps to reproduce** 47 | 48 | If applicable, this section should provide a detailed list of steps needed to reproduce the issue. 49 | 50 | 3. **Miscellaneous information** 51 | 52 | Information that doesn't necessarily fit into any other sections. Common examples are attachments, images, or disclaimers. 53 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Issues 2 | ====== 3 | 4 | This is a public issue-tracking repository for bugs and confirmed features related to the Overcast Network. 5 | 6 | ### Important: 7 | 8 | If you find a potential exploit or vulnerability, please exercise reasonable disclosure: 9 | 10 | 1. Privately [contact Overcast Network staff](mailto:support@oc.tc?subject=Important%20security%20vulnerability) about the issue. 11 | 2. **Do not** publicly disclose the issue immediately (give Overcast Network staff adequate time to respond to and address your inquiry before you disclose the vulnerability publicly). 12 | 13 | ## Submitting 14 | 15 | Issues can be [submitted](https://github.com/OvercastNetwork/Issues/issues/new) at the [issue tracker](https://github.com/OvercastNetwork/Issues/issues). 16 | 17 | ### Do: 18 | 19 | * Follow the [formatting guide](#formatting) to the best of your ability, making sure to include steps to reproduce your issue 20 | * Search the issue tracker to ensure that your issue is not a duplicate 21 | * Verify the validity and/or plausibility of your issue 22 | * Be clear and concise in your description 23 | * Take advantage of [GitHub Flavored Markdown](http://github.github.com/github-flavored-markdown/)--it's awesome, and it makes your submission that much better! :smile: 24 | * Use a *vanilla* environment, making sure to remove any browser extensions or client-side mods 25 | 26 | ### Do not: 27 | 28 | * Bump issues to receive a response (all issues are acknowledged) 29 | * Argue unproductively in an issue's comments 30 | * Re-create an issue you feel unjustly closed 31 | * Add comments such as :+1:, +1 or "I like this idea" 32 | * Submit issues that are general suggestions, as opposed to *specific, technical* bugs or *confirmed* features 33 | * Create disrespectful or inflammatory comments 34 | 35 | ## Formatting 36 | 37 | It is recommended that issues are formatted using the following template for maximum clarity and readability: 38 | 39 | ### Title 40 | 41 | Provide a brief summary of the issue. Your title should allow users browsing the tracker to grasp the gist of your issue at a glance. 42 | 43 | **Example**: 44 | 45 | > Avatars not displaying correctly in friends list 46 | 47 | ### Description 48 | 49 | Try to separate your description into three different sections, if possible: 50 | 51 | 1. **The issue** 52 | 53 | This section should provide a detailed explanation of the issue. 54 | 55 | 2. **Steps to reproduce** 56 | 57 | If applicable, this section should provide a detailed list of steps needed to reproduce the issue. 58 | 59 | 3. **Miscellaneous information** 60 | 61 | Information that doesn't necessarily fit into any other sections. Common examples are attachments, images, or disclaimers. 62 | --------------------------------------------------------------------------------