Skip to content

Latest commit

 

History

History
106 lines (80 loc) · 5.8 KB

CONTRIBUTE.md

File metadata and controls

106 lines (80 loc) · 5.8 KB

Project Contribution Guide

This document provides guidance for how YOU can collaborate with our project community to improve this technology.

Team members

Meet and join our Team of Contributors.

Learn & listen

This section includes ways to get started with your open source project. Include links to documentation and to different communication channels:

Community

Participating in our project community spans a variety of activities:

  • Reporting bugs and enhancements requests
  • Contributing bug/feature solutions
  • Improving documentation
  • Identifying and tracking new use cases
  • Create an example of the project in real world by building something or showing what others have built.
  • Blog about other people’s projects based on this project. Show how it’s used in daily life. Take screenshots and make videos!

To join our community see the Onboarding Resources page in the wiki.

Project Management

Our project uses a combination of GitHub Issues and Project Kanban Dashboards to manage sprint plans.

Project Roadmap

Our vision for the maturation of this project is outlined in the Project Roadmap which is reflective of our intended milestones/release plan.

Meetings

Logistics for Project Triage Sessions:

Project Management:

Contributing Issue/Feature Reports

When submitting Issue/Feature Reports, please use the provided templates and try to convey answers for the following:

  • Is the bug reproducible as explained?
  • Is it reproducible in other environments (for instance, on different browsers or devices)?
  • Are the steps to reproduce the bug clear? If not, can you describe how you might reproduce it?
  • What tags should the bug have?
  • Is this bug something you have run into? Would you appreciate it being looked into faster?

Contributing Code

Community Adoption

Strategically, Discover Financial Services intends for this repository to be promoted for maturation upstream within a yet-to-be-identified community such as FINOS, The A11y Project, or OpenJS. Once we see broader community contributions we will aggressively work towards that the promoting of this project. If and when such a transfer occurs, normal pull request based contributions will be possible.

Incubation Period

For the tactical timeframe (for as long as this repo resided within the DFS GitHub organization), pull request will not be accepted. For those willing to answer our call for contributions, please proceed by:

  1. 'forking` one of the project repositories
  2. Developing a contribution within your forked repo
  3. Opening an issue or feature enhancement report where a redirect to the new contribution (forked repo) is captured.
  4. Add the GitHub Topic a11y-tb to your forked repo for that we can query all of GitHub for available features and fixes to import.

Coding Conventions

  • ReactJS:
    • PascalCase: ReactJS components, interfaces, component file names (tsx, jsx, css)
    • camelCase: JavaScript data variables, functions, non-component file names (ts, js, css)
    • Tab: 4 spaces
  • NodeJS:
    • camelCase: JavaScript data variables, functions, non-component file names
    • Tab: 4 spaces
  • CSS:
    • kebab-case: CSS variables
    • Tab: 2 spaces
  • Other
    • kebab-case: Directories and file names
    • UPPERCASE: Some root markdown files that are commonly all caps

References:

Testing

Testing new releases and/or features is a great way to contribute to the community. If you find issues, please submit an Issue/Feature Report.

Documentation

Learn how to develop, build, test, and contribute to the online docs.

Translations

Our project aspires to be globally applicable but that requires internationalization support beyond the English language. We seek help in:

  • Providing instructions for extending internationalization support;
  • Providing specific language translation enhancements.