- If you don’t have a GitHub account, you’ll need to create one
- If haven’t contributed to Kytos-ng before, you’ll need to digitally sign the CLA
- Make sure that there’s an existing aligned issue that will be linked in the PR
- Contributions are more than welcome
- Small PRs are encouraged instead of large ones
- Breaking changes, architectural or significant changes that can impact Kytos-ng ecosystem should be discussed and aligned first with core members
- The branch name typically follows this pattern
- Make sure linters and unit tests are passing with
- Summarize the PR title and add a tag
- Optionally, depending on the impact of your change, it might be helpful to also run kytos-end-to-end-tests and include a summary of the results in a
### End-to-end Testssubsection.
The following template is encouraged to be used:
See updated changelog file and/or add any other summarized helpful information for reviewers
### Local Tests
### End-to-End Tests
#<issue_numberis for automatically closing the issue that this PR addresses
### Summarywill typically be
See updated changelog fileor also include additional helpful information for reviewers
### Local Testssubsection is for documenting and explaining how you’ve validated and explored your change locally with
kytosdin addition to shipping unit tests. Make sure to also check that there aren’t errors on
kytosdconsole or in the logs.
### End-to-end Testssubsection is optional depending on the impact of the change
That’s it. Once your PR is submitted make sure to keep an eye on your PR notifications for any follow ups, once it’s approved, a core team member will merge it.
Thanks for contributing to Kytos-ng.