Considering about contributing? Great! Contributions are very welcome indeed.
Here are some guidelines to contributing to this project.
- Try to provide as much information about the issue as possible
- Feel free to ask questions, we try to answer to the best of our ability
- One issue per issue, so we have the possibility to stay on the topic :)
- Write descriptive commit messages
- Add proper references (links) to at least the user.js file itself and preferably to the commit message also
- References need to be from trusted sources (e.g. Mozilla bug tracker, or other Mozilla documentation). Or it needs to be somehow verifiable.
- One issue/feature set in one commit (you can use
git add -pfor that), so it's easy to track the changes in the log and process the pull requests- Preferably in separate pull requests. This way it's also easier to discuss about different settings/features.
- Cosmetic changes (wording, typos, etc.) in their own pull requests
- Doublecheck, that the JavaScript syntax is correct
- Pay attention to quotes
- Make sure that the value is of correct type
- Doublecheck, that it's not already there (e.g.
grepfor the stuff you are about to include) - When disabling Firefox features/funcionality, try to do it with minimal amount of switches (e.g. if there's a "main on-off" switch for something, it's enough to use that and not to tweak every parameter related to the feature in question)
Removing obsolete settings has raised some discussion in this project. Usually, when Firefox gets rid of some setting/feature, it doesn't hurt even though we have it in the user.js file. It's just not being used and clutters up the user.js.
When suggesting to remove some setting, please consider the following:
- Just because some setting doesn't show up in
about:configby default, does not mean that Firefox wouldn't utilize that setting somehow - Provide a reference to e.g. Mozilla bug tracker, that describes the removal of this particular setting/feature