Submission Guidelines
Overview
To be listed in the [email protected] repository, you will need to follow the guidelines below when creating your project. When you are ready to have your project reviewed, you'll need to create an issue on the [email protected] GitHub page. I'll review the details of your submission and project. Once everything is in order, I'll add your details to the official [email protected] repository and your project will be listed on the offical Aspire Budgeting website for others to find and use.
These guidelines are pretty minimal, but they exist to ensure the best possible user experience for users of Aspire and of tools from the [email protected] repository.
This all might sound intimidating but it's not meant to be — I promise I'm friendly 😃.
Request to be added to [email protected]
- Your project's name
- A brief description (in English, no more than 500 characters).
- The link to your project's landing page / link to your spreadsheet
- The classification of your project (must be
SPREADSHEET,APP, orCLI_TOOL).
Guidelines for Spreadsheets
All [email protected] spreadsheets should:
- Adhere to the Aspire Budgeting color palette and use Nunito Sans as the font
- Have a clear and concise UI with well described and intuitive controls
- Instructions for how to copy your spreadsheet into Aspire Budgeting
- Not rely on any Apps Script code
- Have links to:
- The Aspire Budgeting website
- The Aspire Budgeting subreddit
- Your personal website, your Twitter page, etc.
- Include a
Getting Startedtab that contains:- An overview of what your spreadsheet does
- How to use your spreadsheet
- Contact information for the developer for the developer if users have a question or feedback
- Screenshots of your spreadsheet in action
Guidelines for Apps / Mobile apps
If you're building an app/mobile app for Aspire, it should:
- Have a Github project or other proejct landing page with clear usage instructions
- Have an issue tracker
- Have a privacy policy
- Have links to:
- The Aspire Budgeting website
- The Aspire Budgeting subreddit
- Your personal website, your Twitter page, etc.
Guidelines for CLI tools & scripts
If you're building a CLI tool for Aspire, it should:
- Have a Github project or other proejct landing page with clear usage instructions
- Have an issue tracker
- Have a privacy policy
- Have links to:
- The Aspire Budgeting website
- The Aspire Budgeting subreddit
- Your personal website, your Twitter page, etc.
Last modified 1yr ago