Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 3.79 KB

CONTRIBUTING.MD

File metadata and controls

87 lines (64 loc) · 3.79 KB
Raw

Contributing

Welcome! The Goldfinch community is on a mission to improve access to capital and increase financial inclusion. We're so glad to have your help! This guide gives an overview of how you can contribute to the code, and tips for doing so.

Please note we have a code of conduct below, please follow it in all your interactions with the project.

Lifecycle of Contributing

  1. Create an issue (on Github Issues) or pick up an issue already raised by someone else. Issues can be bugs, new features / ideas, or chores.
  2. Propose a rough idea of how you plan to solve it, so you don't waste time doing something that won't be accepted.
  3. Write your code!
  4. Raise a PR
  5. Get comments / feedback, and re-submit
  6. Repeat step 5 until it's approved.
  7. Merge!

Tips for writing a great PR

  • Follow existing style conventions
  • Write tests for your change!
  • Give useful context on why you made particular dev decisions, especially if they might be seen as unusual or unexpected.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

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

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

The Goldfinch Community is responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

The Goldfinch Community have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting community members via admin@goldfinch.finance. The Discord dev channel, or through Github comments is also acceptable if you are OK with others knowing you raised the concern. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's community leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4