Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 2.41 KB

CONTRIBUTING.rst

File metadata and controls

49 lines (39 loc) · 2.41 KB
Raw

Contributing to Edunext Codejail

Contributions to Edunext Codejail are very welcome, and strongly encouraged! Here's a step-by-step guide that should help you get started.

Step 0: Join the Conversation

Got an idea for how to improve the codebase? Fantastic, we'd love to hear about it! Before you dive in and spend a lot of time and effort making a pull request, it's a good idea to discuss your idea with other interested developers and/or the Edunext product team. You may get some valuable feedback that changes how you think about your idea, or you may find other developers who have the same idea and want to work together.

Step 1: Branch, Commit and Pull Request

  • As a suggestion, create a branch of the form <name_developer/name_feature>
  • Make all the changes and improvements it requires
  • Make sure to commit according to the standards of conventional commits.
  • A PR of the branch containing the changes to 'main' is created.
  • The branch must be up to date with respect to 'main'. Use rebase for this.
  • The PR must have an update of the file CHANGELOG.rst. All changes contained in the branch to be merged must be specified as 'unreleased'.
  • Once the PR is approved, we perform squash and merge.

Step 2: Make Releases

  1. In development, we position ourselves in the main branch and update it.

  2. bumpversion: Then we write in console:

    bumpversion [major, minor, patch]

  3. The changes that are in 'unreleased' become 'released', they are identified with the date and the version that has generated bumpversion.

  4. The commit generated by bumpversion is pushed, which must also include the recent change in CHANGELOG.rst.

  5. The tag generated by bumpversion is pushed:

    git push origin <tag_bumpversion_generated>

  6. Make github release.

  7. [OPTIONAL] Update the repositories with the new version of the plugin.