Skip to content

Latest commit

 

History

History
47 lines (26 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

47 lines (26 loc) · 3.11 KB

Contributing guide

Want to contribute? Great!

We try to make it easy, and all contributions, even the smaller ones, are more than welcome. This includes bug reports, fixes, documentation, examples... If you are looking for an issue to work on and haven't had much previous experience with Narayana then you could work on one that has the label "good-first-issue" or look for issues whose "Estimated Difficulty" field is Low.

If you can't find any such issues then please contact us using our forum or via chat.

Legal

All original contributions are subject to the guidelines in the main narayana repository with the exception that we ask contributors not to include copyright statements, or license identifiers in contributed files, prefering instead for attribution to be tracked by information contained in the git commit. This policy makes it easier for developers to use the quickstarts to jumpstart their own development.

Reporting an issue

To report the issue use the follow the guidelines in the main narayana repository.

Making open source more inclusive

Red Hat is committed to eradicating problematic language in all of our interactions, including code, documentation, web properties, etc (https://www.redhat.com/en/blog/making-open-source-more-inclusive-eradicating-problematic-language). Although the Narayana project has no plans to retrospectively update its materials we do ask that all contributors be cognizant of the language they use in all communications related to Narayana.

Running

Instructions for running quickstarts are in the README file in the root directory of this repository.

Guidelines

We follow Open source participation guidelines

Continuous Integration

To ensure Narayana is stable for everyone, all changes should go through Narayana continuous integration: when you raise a pull request one of the members of the team will schedule a CI run to test your PR. Note that when a CI test axis passes there is no need to disable further testing of the axis (the danger of doing this is that if further commits are added to the PR then the axis will not be retested).

Tests and documentation are not optional

Don't forget to include tests in your pull requests. Also remember to include relevant documentation (reference documentation for features, javadoc...) for any changes you make.