CONTRIBUTING.md

   1 Contributing
   2 ============
   3
   4 Considering about contributing? Great! Contributions are very welcome indeed.
   5
   6 Here are some guidelines to contributing to this project.
   7
   8 Issues
   9 ------
  10
  11 * Try to provide as much information about the issue as possible
  12 * Feel free to ask questions, we try to answer to the best of our ability
  13 * One issue per issue, so we have the possibility to stay on the topic :)
  14
  15 Pull requests
  16 -------------
  17
  18 * Write descriptive commit messages
  19 * Add proper references (links) to at least the user.js file itself and preferably to the commit message also
  20   * References need to be from trusted sources (e.g. Mozilla bug tracker, or other Mozilla documentation). Or it needs to be somehow verifiable.
  21 * One issue/feature set in one commit (you can use ```git add -p``` for that), so it's easy to track the changes in the log and process the pull requests
  22   * Preferably in separate pull requests. This way it's also easier to discuss about different settings/features.
  23 * Cosmetic changes (wording, typos, etc.) in their own pull requests
  24 * Doublecheck, that the JavaScript syntax is correct
  25   * Pay attention to quotes
  26   * Make sure that the value is of correct type
  27 * Doublecheck, that it's not already there (e.g. ```grep``` for the stuff you are about to include)
  28 * 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)
  29
  30 Removing settings
  31 -----------------
  32
  33 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.
  34
  35 When suggesting to remove some setting, please consider the following:
  36
  37 * Just because some setting doesn't show up in ```about:config``` by default, does not mean that Firefox wouldn't utilize that setting somehow
  38 * Provide a reference to e.g. Mozilla bug tracker, that describes the removal of this particular setting/feature