Please review this document for details regarding getting started with your first contribution, packages you'll need to install as a developer, and our Pull Request process. If you have any questions, please let us know by posting your question as an issue.
Before you begin: Have you read the Code of Conduct? The Code of Conduct helps us establish community norms and how they'll be enforced.
Issues are very valuable to this project.
- Ideas are a valuable source of contributions others can make
- Problems show where this project is lacking
- With a question you show where contributors can improve the user experience
Thank you for creating them.
Pull requests are a great way to get your ideas into this repository.
When deciding if we merge in a pull request we look at the following things:
You should be clear which problem you're trying to solve with your contribution.
For example:
Add link to code of conduct in README.md
Doesn't tell me anything about why you're doing that
Add link to code of conduct in README.md because users don't always look in the CONTRIBUTING.md
Tells us the problem that you have found, and the pull request shows us the action you have taken to solve it.
- There are no spelling mistakes
- It reads well
- For english language contributions: Has a good score on Grammarly or Hemingway App
The aim of this repository is:
- To provide a sample for Falcon Foundry so users can learn from it
- The content is usable by someone who hasn't written something like this before
- Foster a culture of respect and gratitude in the open source community.
This repository has a code of conduct, we will remove things that do not respect it.
