spotters.md

Hello! Welcome to the spotter team 👋

As a spotter, you are here to improve creedengo by finding new rules to implement on one of our static analysers.

Prerequisites

Here are the things you need to succeed in this challenge:

• Your experience and your brain 😤
• A computer with an internet connection should help you ask your favourite search engine or AI for help.
• A GitHub account to share your hard work with the community

📜 Identify new ecodesign rules

Does my rule already exist in creedengo?

For Android and iOS rules, here are the rules already found: best pratices mobile

For other plugin rules, there is no centralised place to list all the rules that have been implemented or are in progress. To check if your rule already exists or has been proposed, please check the following sources:

• creedengo implemented rule specification folder: contains all the description of the implemented rules
• creedengo Rules.md: a partial list of accepted and not accepted rules. Your new rule should not be here!
• creedengo canditate rules kanban: a list of work in progress rules.
• check the issues in the plugin project of the language of your rule. For example, for Java check the Java creedengo plugin issues. Some rules there are not complete. If you found a duplication of your rule but you think that you have the missing justification (for example), ask a coach if you can complete the rule!

What is a good rule definition?

Now you have an idea. Have you checked that it has not already been submitted? Great, you have a baby rule. Here are the things you need to do to turn it into a nice, mature rule:

• A short but explicit title
• The language / platform your rule applies
• A description of what your rule does (and does not do) with code example: what is the code my static analyzer must detect and why?
• The justification of the rule: documentation reference or measure (or at least an approach to perform the measure) that explains why your rule is relevant

Good examples of rule definitions can be found here:

• Example of rule definition with measure validation
• Example of rule definition with documentation validation

What is the submission process for my work?

Your rule is ready and you want to submit it? Connect to the Green Code Initiative GitHub - creedengo Challenge project and perform the following steps:

1- Go to the Issues tab and click on the New Issue button

2- Select the [Hachaton 2024] Spotter rule description template and click on Get Started

3- Fill in the template with your rule and click on Submit new issue

And that's it!

Questions?

If you have any questions, ask a coach or use the challenge Slack:

• creedengo public Slack
  • Main channel: challenge24-general
  • Spotters channel: challenge24-spotters

You can also create private discussions with all members of your team using the direct messages Slack feature.