How to contribute
Last updated
Was this helpful?
Last updated
Was this helpful?
Create an issue or find an existing issue on
Assign the issue to yourself
Create a branch using the issue id, for example if the issue you are working on is 600, then create a branch call 600-issue , this way , github will link your PR with the issue
Raise a PR , and submit it for the team to review
Make sure the pipeline is green
Once PR get approved, you can merge it to master
SwipeNode manage changelog entry the same way like github, refer to () for more detail. Once a merge request get merged into master branch, if the merge request upgrade the , then a new release will be created automatically, and the repository will be tagged with the new version by the release tool.
A scripts/changelog is available to generate the changelog entry file automatically.
Its simplest usage is to provide the value for title:
At this point the script would ask you to select the category of the change (mapped to the type field in the entry):
The entry filename is based on the name of the current Git branch. If you run the command above on a branch called feature/hey-dz, it will generate a changelogs/unreleased/feature-hey-dz.yml file.
The command will output the path of the generated file and its contents:
Arguments
Argument
Shorthand
Purpose
--amend
Amend the previous commit
--force
-f
Overwrite an existing entry
--merge-request
-m
Set merge request ID
--dry-run
-n
Don’t actually write anything, just print
--git-username
-u
Use Git user.name configuration as the author
--type
-t
The category of the change, valid options are: added, fixed, changed, deprecated, removed, security, performance, other
--help
-h
Print help message
--amend
You can pass the --amend argument to automatically stage the generated file and amend it to the previous commit.
If you use --amend and don’t provide a title, it will automatically use the “subject” of the previous commit, which is the first line of the commit message:
--force or -f
Use --force or -f to overwrite an existing changelog entry if it already exists.
--merge-request or -m
Use the --merge-request or -m argument to provide the merge_request value:
--dry-run or -n
Use the --dry-run or -n argument to prevent actually writing or committing anything:
--git-username or -u
Use the --git-username or -u argument to automatically fill in the author value with your configured Git user.name value:
--type or -t
Use the --type or -t argument to provide the type value: