Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 3.11 KB
Raw

Contributing

Welcome to NotionCLI!

Firstly, I would like to say thank you for considering contributing to this project! Here are some guidelines to help ensure your contribution is smoothly integrated.

Table of Contents

Code of Conduct

By participating, you are expected to uphold our Code of Conduct. Basically, be nice and contribute useful stuff.

Prerequisites

Before contributing, please review existing issues and documentation.

How to Contribute

If you wish to contribute to this repository, you'll need to:

  1. Fork the repository to your own GitHub account
  2. Clone it to your local device
  3. Create a new branch for your changes
  4. Make the changes
  5. Push your changes to your fork
  6. Submit a pull request so that we can review and integrate your changes

For more detailed instructions, please refer to the GitHub Documentation: Creating a pull request from a fork.

What to Contribute

There are many ways you can contribute, from writing tutorials, improving the documentation, reporting bugs, submitting enhancement suggestions, and more. Additional use cases, test coverage and functionality are also welcome.

Pull Request Process

  1. Ensure any install or build dependencies are properly documented.
  2. Update the README.md with the details of changes, including new environment variables, exposed ports, useful file locations, and container parameters.
  3. Submit your pull request with detailed explanation of changes. Reference the issue it resolves (if applicable).
  4. Await approval from maintainers. They will provide feedback and may request some changes to your pull request.

Please note that this project adheres to the Conventional Commits guidelines.

Commit Message Guidelines

This project uses the Conventional Commits format for commit messages:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

The type must be one of the following:

  • fix: A bug fix
  • feat: A new feature
  • docs: Documentation-only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

If the change introduces breaking changes, please add BREAKING CHANGE: at the beginning of its optional body or footer section.

License

By contributing to this project, you agree that your contributions will be licensed under the Apache 2.0 License.

Thank you for spending your time to improve this project!