Skip to content

goodload/goodload

Repository files navigation

Goodload Load Tester

User friendly and extensible library for automated load testing!

How To Contribute

Bugs, Issues and Feature Requests

If you have discovered a bug, or want a new feature to be included, create an issue on Github under the project repository. Bugs, and issues (including feature requests) related to extensibility and user-friendliness will be put on highest priority. While raising an issue, please mention the use-case, steps to reproduce the bug (if it is a bug) and other such information that may help us and the comminuity to understand your issue and resolve it quickly. Don't forget to put proper labels on your issues as they will help us in filtering and prioritizing your issue.

Be respectful and polite to others. :)

Pull Requests

If you want to contribute, you can raise a pull request to merge your work (code or other contribution) to develop branch. The pull requests to merge with master will be rejected for non-priority issues. Before the pull request is merged, it needs to pass certain checks-

  1. Approved by a maintainer
  2. Security clearance by Git Guardian : It identifies security issues due to inclusion of information in commits that otherwise should be kept secret (such as passwords and ecryption keys).
  3. Successful Build : The code should build successfully and all the test cases should pass.
  4. Sonar quality gates : When you create a pull request or update your pull request, and the build step completes successfully, a sonar report for your branch is generated at https://sonarcloud.io/dashboard?id=goodload_goodload. At the top-left choose your branch to see the sonar report for your branch. All the quality gates should pass.
  5. Sign Contributor License Agreement (CLA) : We ask you to sign a CLA before we can merge your pull request. You need to do this only the first time you raise a pull request, your acceptance is valid for all your pull requests thereafter. The CLA Assistant Bot will ask you to sign the CLA if you haven't already done so. Note that if we change our CLA at any time, then you might need to read and sign it again. You can find a copy of the license here.

Raising effective pull request

  1. Keep the title short and to the point.
  2. Use title format "ISS <Issue Number> : <Description>" if the pull request addresses an issue that has been raised on GitHub.
  3. Describe your work in detail in description of the pull request.
  4. If you are queried for more information about the PR, please provide it as soon as possible.
  5. A PR will be closed if it remains inactive for more than 2 months
  6. Be respectful and polite to others.

After the pull request has been merged with develop or master branch, the build is run again, along with the sonar quality gates. This time, whole code in the develop or master branch is analyzed by Sonar.

License and Copyright

Copyright (C) 2021 Divyansh Shekhar Gaur

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.