Skip to content

Latest commit

 

History

History
128 lines (79 loc) · 6.22 KB

CONTRIBUTING.md

File metadata and controls

128 lines (79 loc) · 6.22 KB
Raw

Contribution Guidelines

Contributions to the KiiPy library are welcome. As a contributor, here are the guidelines we would like you to follow:

Code of Conduct

Please read and follow our Code of Conduct.

Question or Problem?

Please use GitHub Discussions for support related questions and general discussions. Do NOT open issues as they are for bug reports and feature requests. This is because:

  • Questions and answers stay available for public viewing so your question/answer might help someone else.
  • GitHub Discussions voting system ensures the best answers are prominently visible.

Found a Bug?

If you find a bug in the source code submit a bug report issue. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting a feature request issue. If you would like to implement a new feature:

Submission Guidelines

Submitting an Issue

Before you submit an issue, please search the issue tracker. An issue for your problem might already exist and the discussion might inform you of workarounds readily available.

For bug reports, it is important that we can reproduce and confirm it. For this, we need you to provide a minimal reproduction instruction (this is part of the bug report issue template).

You can file new issues by selecting from our new issue templates and filling out the issue template.

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

  1. All Pull Requests should be based off of and opened against the main branch.

  2. Search Existing PRs for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.

  3. Be sure that an issue exists describing the problem you're fixing, or the design for the feature you'd like to add.

  4. Fork the repository.

  5. In your forked repository, make your changes in a new git branch created off of the main branch.

  6. Make your changes, including test cases and documentation updates where appropriate.

  7. Follow our coding rules.

  8. Run all tests and checks locally, as described in the development guide, and ensure they pass. This saves CI hours and ensures you only commit clean code.

  9. Commit your changes using a descriptive commit message that follows our commit message conventions.

  10. Push your branch to GitHub.

  11. In GitHub, send a pull request to KiiBlockchain:main.

Reviewing a Pull Request

The KiiPy team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following our code of conduct and applies within or outside the managed channels.

When you contribute a new feature, the maintenance burden is transferred to the core team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature.

Addressing review feedback

If we ask for changes via code reviews then:

  1. Make the required updates to the code.

  2. Re-run the tests and checks to ensure they are still passing.

  3. Create a new commit and push to your GitHub repository (this will update your Pull Request).

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the (upstream) repository.

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All code must pass our code quality checks (linters, formatters, etc). See the development guide section for more detail.

  • All features must be tested via unit-tests and if applicable integration-tests. Bug fixes also require tests, because the presence of bugs usually indicates insufficient test coverage. Tests help to:

    1. Prove that your code works correctly, and
    2. Guard against future breaking changes and lower the maintenance cost.

  • All public features must be documented.

  • All files must include a license header.

  • Keep API compatibility in mind when you change any code under kiipy. Above version 1.0.0, breaking changes can happen across versions with different left digit. Below version 1.0.0, they can happen across versions with different middle digit. Reviewers of your pull request will comment on any API compatibility issues.

Commit Message Convention

Please follow the Conventional Commits v1.0.0. The commit types must be one of the following:

  • build: Changes that affect the build system or external dependencies
  • ci: Changes to our CI configuration files and scripts
  • docs: Changes to the documentation
  • feat: A new feature
  • fix: A bug fix
  • nfunc: Code that improves some non-functional characteristic, such as performance, security, ...
  • refactor: A code change that neither fixes a bug nor adds a feature
  • test: Adding missing tests or correcting existing tests