CONTRIBUTING.md

Contributing

Clusview follows the following guidelines regarding issues, PRs and commit history.

Issues

Issues are the main point of information about proposals, bugs, and any other type of discussion.

Explain the problem in detail and the proposed solution. No need to be explicit about code, outlining the high-level view of the changes is sufficient.

Issues are always labeled into three categories:

• module: package that the issue addresses:

  module : repo Repo-wide issues module : core Python core functionality module : ui User Interface module : docs Documentation site with Starlight

• state: progress on the issue.

  state : pending Pending approval. Under discussion state : discarded Won't be worked on state : accepted Ready to be addressed

• type: nature of the problem and changes:

  type : enhancement New feature or improvement type : docs Improvements or additions to documentation type : bug Oops! Something is broken

Pull Requests

Pull requests must always have develop as the target.

The information on their description should be minimal, most of it should be contained in the corresponding issue. Always start with a reference to the issue they are solving. To do so, start your PRs in this way.

Resolves #issueNumber.

If some additional clarification needs to be added that is not addressed in the corresponding issue, feel free to do so.

Creating a PR directly without referring to an issue is possible if the change is trivial, like a typo.