Skip to content

Latest commit

 

History

History
48 lines (40 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

48 lines (40 loc) · 3.24 KB
Raw

Contributing

Bug reports and feature requests

Submit these to https://github.com/GHTaarn/History.jl/issues

Pull requests

I have limited time to develop this application, so good code contributions are welcome. For pull requests, please have the following in mind:

  • Use Julia naming conventions
  • Indent with 4 spaces
  • Use good programming practices
  • Document exported symbols with docstrings
  • Try to use the existing style, even if it is not entirely your taste
  • If you make something that looks stupid at first glance, please explain it with a comment so that people are not tempted to tidy it in an incorrect way (if you make something that looks stupid and is stupid, please tidy it before submitting the pull request (unless it is meant as a mockup))
  • New functions/methods should get a new testcase (functions/methods that are extremely simple are exempted)

For developers with write permission to the History.jl Github repository:

  • Branches are named as in the Julia git repository:

    • master : New feature development. All tests should pass. Version should be x.x.0-DEV
    • release-x.x : A stable release for each minor version, all tests should pass. Unlike the Julia repository, do not commit anything here unless it is verified release ready and has version x.x.x

  • Release procedure for x.x.0 releases: 0. Inform everyone with write permission that you are starting the release procedure

    1. Run unit tests
    2. Read through README.md and try out all code examples to verify that they work
    3. Instruct everyone with write permission to hold off commits to master until you give the green light & check that your master is up to date
    4. Edit Project.toml changing version to x.x.0
    5. Create the branch release-x.x
    6. On the master branch, edit Project.toml and bump up its version to x.x.0-DEV (where the minor version is increased by one, or major version is increased by one and minor version is set to zero)
    7. Push master and the new branch to Github
    8. Inform everyone with write permission that it is safe to commit to master
    9. Write a comment containing the text @JuliaRegistrator register branch=release-x.x on the commit on Github to trigger the Julia registrator to register the new version.
    10. On Github, create a new release, giving release-x.x the tag vx.x.0

  • Release procedure for patch releases (x.x.x releases): 0. Inform everyone with write permission that you are starting the patch release procedure

    1. Create a new temporary branch (e.g. dev-x.x.x) from release-x.x
    2. Commits to the temporary branch should preferably be created using git cherry-pick -x master~ZZZ (or refer to the commit on the master branch in another way)
    3. Increase the version in Project.toml to x.x.x and commit
    4. If you committed blunders to the temporary branch, just delete it and create a new one
    5. Test the temporary branch
    6. Merge the temporary branch into release-x.x (e.g. git switch release-x.x; git merge --no-ff dev-x.x.x)
    7. Push to Github
    8. Write a comment containing the text @JuliaRegistrator register branch=release-x.x on the commit on Github to trigger the Julia registrator to register the new version.
    9. On Github, create a new release, giving release-x.x the tag vx.x.x