You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

151 lines
5.5 KiB

4 years ago
  1. # Contributing to Glances
  2. Looking to contribute something to Glances ? **Here's how you can help.**
  3. Please take a moment to review this document in order to make the contribution
  4. process easy and effective for everyone involved.
  5. Following these guidelines helps to communicate that you respect the time of
  6. the developers managing and developing this open source project. In return,
  7. they should reciprocate that respect in addressing your issue or assessing
  8. patches and features.
  9. ## Using the issue tracker
  10. The [issue tracker](https://github.com/nicolargo/glances/issues) is
  11. the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests)
  12. and [submitting pull requests](#pull-requests), but please respect the following
  13. restrictions:
  14. * Please **do not** use the issue tracker for personal support requests. A official Q&A exist. [Use it](https://groups.google.com/forum/?hl=en#!forum/glances-users)!
  15. * Please **do not** derail or troll issues. Keep the discussion on topic and
  16. respect the opinions of others.
  17. ## Bug reports
  18. A bug is a _demonstrable problem_ that is caused by the code in the repository.
  19. Good bug reports are extremely helpful, so thanks!
  20. Guidelines for bug reports:
  21. 0. **Use the GitHub issue search** — check if the issue has already been
  22. reported.
  23. 1. **Check if the issue has been fixed** — try to reproduce it using the
  24. latest `master` or `develop` branch in the repository.
  25. 2. **Isolate the problem** — ideally create a simple test bed.
  26. 3. **Give us your test environment** — Operating system name and version
  27. Glances version...
  28. Example:
  29. > Short and descriptive example bug report title
  30. >
  31. > Glances and psutil version used (glances -V)
  32. >
  33. > Operating system description (name and version).
  34. >
  35. > A summary of the issue and the OS environment in which it occurs. If
  36. > suitable, include the steps required to reproduce the bug.
  37. >
  38. > 1. This is the first step
  39. > 2. This is the second step
  40. > 3. Further steps, etc.
  41. >
  42. > Screenshot (if usefull)
  43. >
  44. > Any other information you want to share that is relevant to the issue being
  45. > reported. This might include the lines of code that you have identified as
  46. > causing the bug, and potential solutions (and your opinions on their
  47. > merits).
  48. ## Feature requests
  49. Feature requests are welcome. But take a moment to find out whether your idea
  50. fits with the scope and aims of the project. It's up to *you* to make a strong
  51. case to convince the project's developers of the merits of this feature. Please
  52. provide as much detail and context as possible.
  53. ## Pull requests
  54. Good pull requests—patches, improvements, new features—are a fantastic
  55. help. They should remain focused in scope and avoid containing unrelated
  56. commits.
  57. **Please ask first** before embarking on any significant pull request (e.g.
  58. implementing features, refactoring code, porting to a different language),
  59. otherwise you risk spending a lot of time working on something that the
  60. project's developers might not want to merge into the project.
  61. First of all, all pull request should be done on the `develop` branch.
  62. Glances uses PEP8 compatible code, so use a PEP validator before submitting
  63. your pull request. Also uses the unitaries tests scripts (unitest-all.py).
  64. Similarly, when contributing to Glances's documentation, you should edit the
  65. documentation source files in
  66. [the `/doc/` and `/man/` directories of the `develop` branch](https://github.com/nicolargo/glances/tree/develop/docs) and generate
  67. the documentation outputs files by reading the [README](https://github.com/nicolargo/glances/tree/develop/docs/README.txt) file.
  68. Adhering to the following process is the best way to get your work
  69. included in the project:
  70. 1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
  71. and configure the remotes:
  72. ```bash
  73. # Clone your fork of the repo into the current directory
  74. git clone https://github.com/<your-username>/glances.git
  75. # Navigate to the newly cloned directory
  76. cd glances
  77. # Assign the original repo to a remote called "upstream"
  78. git remote add upstream https://github.com/nicolargo/glances.git
  79. ```
  80. 2. Get the latest changes from upstream:
  81. ```bash
  82. git checkout develop
  83. git pull upstream develop
  84. ```
  85. 3. Create a new topic branch (off the main project development branch) to
  86. contain your feature, change, or fix (best way is to call it issue#xxx):
  87. ```bash
  88. git checkout -b <topic-branch-name>
  89. ```
  90. 4. It's coding time !
  91. Please respect the following coding convention: [Elements of Python Style](https://github.com/amontalenti/elements-of-python-style)
  92. Commit your changes in logical chunks. Please adhere to these [git commit
  93. message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
  94. or your code is unlikely be merged into the main project. Use Git's
  95. [interactive rebase](https://help.github.com/articles/interactive-rebase)
  96. feature to tidy up your commits before making them public.
  97. 5. Locally merge (or rebase) the upstream development branch into your topic branch:
  98. ```bash
  99. git pull [--rebase] upstream develop
  100. ```
  101. 6. Push your topic branch up to your fork:
  102. ```bash
  103. git push origin <topic-branch-name>
  104. ```
  105. 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
  106. with a clear title and description against the `develop` branch.
  107. **IMPORTANT**: By submitting a patch, you agree to allow the project owners to
  108. license your work under the terms of the [LGPLv3](COPYING) (if it
  109. includes code changes).