-
Notifications
You must be signed in to change notification settings - Fork 2
/
Contributing.html
61 lines (61 loc) · 4.58 KB
/
Contributing.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="generator" content="pandoc">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title></title>
<style type="text/css">code{white-space: pre;}</style>
<link rel="stylesheet" href="./github-markdown.css">
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
<link rel="icon" type="image/x-icon" href="favicon.ico" />
</head>
<body>
<h2 id="contributing">Contributing</h2>
<p>Here are a few ways you can help make this project better!</p>
<h3 id="discussion">Discussion</h3>
<p>If you have any questions or general thoughts about the project, please post them in our <a href="https://github.com/RequestPolicyContinued/requestpolicy/issues/484">general discussion</a></p>
<h3 id="testing-reporting-bugs-requesting-new-features">Testing, reporting bugs & requesting new features</h3>
<p>Always use the <a href="https://addons.mozilla.org/en-US/firefox/addon/requestpolicy-continued/versions/beta">latest release</a>, or <a href="https://github.com/RequestPolicyContinued/requestpolicy#getting-the-source-code">build the XPI from the most recent source revision</a></p>
<p>If you'd like a bug to be fixed or a feature added, <a href="https://github.com/RequestPolicyContinued/requestpolicy/issues">find if it has already been reported</a>. Open a new issue if needed, and add information about the bug/request such as:</p>
<ul>
<li>Steps to reproduce the bug (user actions)</li>
<li>What should happen.</li>
<li>What happens instead.</li>
</ul>
<p>Response time from the maintainers should be around a few days.</p>
<p><strong>Please bear in mind that each user might have a different browser setup. Sometimes it's necessary to further investigate the problem:</strong></p>
<p>Some bugs are caused by other Firefox addons interfering with RequestPolicy. To make sure a bug is caused by RequestPolicy itself:</p>
<ul>
<li>Disable all other addons from Firefox's addon manager</li>
<li>Try to reproduce the bug</li>
</ul>
<p>If the bug does <em>not</em> happen with only RPC enabled, the bug is related to another addon:</p>
<ul>
<li>Re-enable one addon, test again.</li>
<li>Repeat until the problem occurs again</li>
<li><a href="https://github.com/RequestPolicyContinued/requestpolicy/issues">Report us</a> the incompatible addon (with a link to the addon download page)</li>
</ul>
<p>To test if the bug is related to your specific configuration, you can <a href="https://support.mozilla.org/en-US/kb/profile-manager-create-and-remove-firefox-profiles">create a new, blank Firefox profile</a> and try to reproduce the bug.</p>
<h3 id="code-contributions">Code contributions</h3>
<p>You can look through the existing bugs/requests <a href="https://github.com/RequestPolicyContinued/requestpolicy/issues">here</a>.</p>
<p>You can find bugs that should be easy to fix <a href="https://github.com/RequestPolicyContinued/requestpolicy/labels/easy">here</a>.</p>
<p>More information on RequestPolicy development can be found <a href="https://github.com/RequestPolicyContinued/requestpolicy/wiki">here</a></p>
<h3 id="translations">Translations</h3>
<p>You can help us translate our project by <a href="https://github.com/RequestPolicyContinued/requestpolicy/tree/dev-1.0/src/locale">editing the locale files</a> and sending us a Pull Request.</p>
<h3 id="documentation-and-website">Documentation and website</h3>
<p>You can help build and design the website and documentation <a href="https://github.com/requestpolicycontinued/requestpolicycontinued.github.io">here</a></p>
<h3 id="bug-triage">Bug triage</h3>
<p>You can help us find more info about <a href="https://github.com/RequestPolicyContinued/requestpolicy/issues?q=is%3Aopen+is%3Aissue+label%3Aunconfirmed+">unconfirmed bugs</a> by finding if the bug is reproducible. In what environment? What are the steps to reproduce?</p>
<p>You can ask the maintainers to close already fixed bugs by testing old tickets to see if they are happening, or remove duplicate bug reports.</p>
<h3 id="donations">Donations</h3>
<p>You can add <a href="https://www.bountysource.com/teams/requestpolicycontinued/issues">bounties at bountysource</a> for bugs you would like to be fixed.</p>
<h3 id="community-and-support">Community and support</h3>
<ul>
<li>You can help us answer questions our users have on the issue tracker</li>
<li>You can write posts about the project, take screenshots and make videos, share RequestPolicy Continued on the Internet, show how it's used in daily life, and talk about it to your friends.</li>
</ul>
</body>
</html>