Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (36 loc) · 4.59 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 4.59 KB

Reporting Issues with xDrip

Before opening an issue, please communicate with us by posting in "Discussions":
https://github.com/NightscoutFoundation/xDrip/discussions We will encourage you to open an issue if it is not already known and there is no work-around.

Please provide as much information as possible when communicating your concerns with us:

  • If it is a bug, please try to explain how to reproduce it, roughly which settings you are using, what you are seeing or not seeing. Screenshots welcomed.
  • If it relates to a new feature, please explain the rationale for the feature, use cases and detail your suggestion.

Contributing patches to xDrip

Do you have an idea for a feature or enhancement or bugfix for Nightscout xDrip?

Patches are welcomed! To ensure the best all round results they need be a good fit with the project roadmap, the ecosystem of users and respect overall project stability and good practice.

The best way to get patches accepted is to discuss your ideas with project maintainers using Discussions prior to implementation and discuss how to structure things so that they can fit well within the project and also the rationale for the change.

Copyright of submitted contributions

Any submitted patches and pull requests must either be the original work of the submitter or be available under a suitable open source license which is compatible with inclusion in a GPL licensed project.

This also applies to graphics, sounds or other binary file content. Ideally these should be either the original work of the submitter or be in the public domain. They should not contain trademarks.

Project reviewers are likely to use criteria similar to that outlined below:

  • Does the patch affect any existing functionality? What is the impact of the change?
  • Does the patch enhance the app in a way which is proportional to the change being made?
  • Can any significant behavioral change be controlled with a settings switch without excessively increasing the user interface complexity?
  • Is there an existing maintainer working on the affected area with possibly parallel activity?
  • Are there any other potential negative consequences to the change?
  • Does the patch contain any unrelated changes?
  • Has the patch been properly tested?

Make sure any pull request has a clear title and a good description.

Try not to bundle different patches together and keep the change set to the minimum required. Even unrelated changes to whitespace have to be reviewed in case a random keystroke broke something. The less lines there are to review, the clearer the patch will be to any reviewer.

Maintainers are not always immediately aware of pull request submissions, which is another reason why it helps to have discussed your work prior to submission. Feel free to ask about the progress of processing your PR as maintainers may not realise a PR is awaiting action.

Policy on AI based submissions (pull requests)

AI can be a useful tool, especially for accelerating changes which might be menial and assisting less experienced developers. However, in order to ensure the smooth running of the project, the following rules are applied relating to AI submissions.

  • Automated agentic or bot based submissions are not allowed. A human must be responsible for raising the change set.
  • You take full responsibility for all code submitted no matter how it was created. You must be fully aware and understand all of the code.
  • Copyright is assumed to be a hybrid of human authored copyright which you are assigning fully to the project when submitting a pull request. You are asserting that all code is effectively your own work and does not infringe copyright.
  • Agentic workflows or bot replies must not be used to respond to comments on your pull request. We reserve the right to block users who raise or respond to PRs / Issues / Discussions using automation. You can use AI to help you respond to queries but this process must not be automated.
  • Be aware that submissions are reviewed by humans who have limited bandwidth and so, regardless of the technical merit of a submission, there are limits to the amount of time which will be spent reviewing features that for other reasons are unsuitable to be accepted. See the earlier guidance on raising your idea for a change in the discussion section before producing code to do it.

Translations

Please use xDrip+ on Crowdin if you have any questions about translations, or like to add a language or contribute to an existing language.

Nightscout xDrip is maintained by volunteers.