Contributing to Lookyloo

You can contribute by:

  • Raising an issue you find in the code or documentation

  • Fixing issues by opening a pull request

  • Improving documentation or code samples

All bugs, tasks or enhancements are tracked as GitHub issues. Use labels to indicate requirements and information related to the reported issue.

Contributor Behavior

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language

  • Focusing on what is best for the community

  • Being respectful of differing viewpoints and experiences

  • Gracefully accepting constructive criticism

Please read our Code of Conduct.

Before You Begin

  • Get started by installing and getting familiar with Git.

  • Use AsciiDoc to contribute to Lookyloo documentation.

  • Refer to our style guide for guidance on formatting your documentation contributions.

General Information

Thank you for your contributions. To start contributing to Lookyloo:

  1. Create an issue describing your proposed change to the repository.

  2. The repository owners will triage and respond to your issue promptly.

  3. Fork the repository.

  4. Submit a pull request with the proposed changes. The required format for the Git commit message is "Issue # <Issue ID> - <issue_message>".

Raising an Issue

GitHub issues can be used to report bugs or submit feature requests.

When reporting an issue, you can use the applicable issue reporting template. Issues should be raised in the corresponding repository.

Please include the following information when creating an issue:

  • Operating system you are using

  • The steps needed to reproduce the issue.

Submit a Pull Request

Make a pull request (PR) to add content to the repository. When making a PR, ensure you include:

  • A description of what the PR fixes

  • Associated Issue # and Issue title (if applicable)

  • Operating system you are using

See the using Git documentation for more information on using Git and making pull requests.