Question

Intégrer du code dans le cœur de Canvas n'est pas trivial. Peut-être que votre changement serait mieux implémenté en tant que service séparé utilisant l'API ou LTI. Nous avons un standard de qualité élevé chez Instructure et si vous n'êtes pas familier avec Ruby et Rails, faire accepter votre code peut être difficile. Nous sommes heureux de donner des suggestions pour améliorer les commits. Chaque commit pour Canvas est examiné par au moins un ingénieur d'Instructure. Chaque ligne est lue et le réviseur est responsable de vérifier le commit et de le tester dans son environnement local. Les messages de commit doivent fournir suffisamment d'informations pour que l'ingénieur sache ce qui a changé et ce qui doit être testé. La liste de contrôle suivante est suivie pour chaque commit : - Vérifier et essayer le jeu de modifications. - S'assurer que le message de commit a un plan de test. - S'assurer que les tests et le plan de test couvrent tous les cas nécessaires. - S'assurer que le code suit les conventions de codage du langage. - S'assurer que le code est bien conçu et architecturé. - S'assurer que toutes les chaînes/dates/heures/nombres visibles par l'utilisateur sont internationalisés. Autres facteurs à considérer : - Doit rester performant sous forte charge. - Doit fonctionner dans un environnement multi-locataire. Les améliorations doivent être construites en utilisant l'architecture de Plugin de Canvas. - Doit être accessible aux lecteurs d'écran et autres dispositifs technologiques d'assistance. - Devrait suivre notre style de codage. Lieux pour commencer Si vous êtes nouveau dans le développement Canvas, il y a des guides dans ce wiki pour configurer votre environnement de développement. Assurez-vous de nous avoir donné un accord de contributeur de code signé, puis commencez par quelque chose de petit. Familiarisez-vous avec le processus de commit avec quelque chose de petit comme une correction de bug ou un ajustement de l'interface utilisateur. Une fois que vous êtes à l'aise, vous pouvez commencer à travailler sur des projets plus importants. Pour tout ce qui dépasse une correction de bug, il est probablement judicieux de coordonner via la liste de diffusion. Demandes de tirage Nous aimons les demandes de tirage GitHub. Si vous signalez un problème, nous aimerions voir une demande de tirage jointe. Gardez à l'esprit que votre commit va probablement être modifié au moins une fois avant d'être accepté. Améliorations et extensions Parce que Canvas Cloud fonctionne comme un environnement multi-locataire, tout changement au code affectera toutes les institutions à la fois. Si vous cherchez à ajouter des fonctionnalités majeures à Canvas, vous devrez garder cela à l'esprit. Pour aider, nous avons intégré la notion de Plugins dans Canvas. Les plugins peuvent être enregistrés à l'exécution mais n'apparaissent dans l'interface que pour les comptes racine activés. Il y a des endroits dans le code qui ont déjà été instrumentés pour les plugins, mais si vous cherchez à étendre la fonctionnalité ailleurs, la première étape sera de pluginifier cette partie du code, puis de construire un plugin pour votre implémentation spécifique. Le moyen le plus simple de se familiariser avec les Plugins Canvas est lib/canvas/plugin.rb et lib/canvas/plugins/default_plugins.