Skip to content
FiNAN Logo FiNAN Docs

Contribution Guidelines

Thank you for your interest in contributing to the FiNAN project! We welcome contributions from developers of all skill levels.

Code of Conduct

Section titled “Code of Conduct”

We are committed to providing a friendly, safe, and welcoming environment for all, regardless of background or experience level. Please be respectful and considerate in your interactions.

PR Process

Section titled “PR Process”

We follow a standard Fork & Pull Request workflow.

  1. Fork the repository on GitHub.
  2. Clone your fork locally:
    Terminal window
    git clone https://github.com/YOUR-USERNAME/finan-website.git
    cd finan-website
  3. Create a branch for your feature or fix:
    Terminal window
    git checkout -b feature/amazing-new-feature
    # or
    git checkout -b fix/annoying-bug
  4. Make your changes.
  5. Commit your changes using a descriptive message.
  6. Push to your fork:
    Terminal window
    git push origin feature/amazing-new-feature
  7. Open a Pull Request against the main branch of the original repository.

Code Review

Section titled “Code Review”

All submissions, including submissions by project members, require review. We use GitHub Pull Requests for this purpose. Consult GitHub Help for more information on using Pull Requests.

What we look for

Section titled “What we look for”
  • Correctness: Does the code do what it’s supposed to do?
  • Style: Does it follow our Style Guide?
  • Safety: Does it introduce any security vulnerabilities?
  • Documentation: Did you update the docs if you changed functionality?