chk
/
AppFlowy-Cloud
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
AppFlowy-Cloud/doc/CONTRIBUTING.md

2.4 KiB
Raw Blame History

Contributing

First of all, thank you for contributing to AppFlowy Cloud! The goal of this document is to provide everything you need to know in order to contribute to AppFlowy Cloud and its different integrations.

Assumptions

  1. You're familiar with GitHub and the Pull Request(PR) workflow.
  2. You know about the AppFlowy community. Please use this for help.

How to Contribute

Contributions are welcome! Here's how you can help improve AppFlowy Cloud:

  1. Identify or propose enhancements or fixes by checking existing issues or creating a new one.
  2. Fork the repository to your own GitHub account. Feel free to discuss your contribution with a maintainer beforehand.
  3. Create a feature or bugfix branch in your forked repo.
  4. Familiarize yourself with the Development Workflow for guidelines on maintaining code quality.
  5. Implement your changes on the new branch.
  6. Open a Pull Request (PR) against the main branch of the original AppFlowy Cloud repo. Await feedback or approval from the maintainers.

Development Workflow

To get the server running locally, execute:

./build/run_local_server.sh

Ensure functionality by executing the test suite:

cargo test

For a pull request (PR) to be considered, it must:

  • Pass all tests.

  • Adhere to clippy linting standards:

    cargo clippy -- -D warnings

    If clippy is not installed:

    rustup update
rustup component add clippy

  • Comply with the code formatting rules. To format your code:

    cargo fmt

    To check formatting:

    cargo fmt --all -- --check