-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #841 from Green-Software-Foundation/contribution-g…
…uide Clarify labels and plugins in contribution guide
- Loading branch information
Showing
1 changed file
with
4 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,15 +24,15 @@ The following document is a rule set of guidelines for contributing. | |
|
||
## What and when to contribute | ||
|
||
You can contribute anything to the IF, but we are likely to close out unsolicited PRs without merging them. Our issue board is completely open and we have tags (`help-wanted`, `good-first-issue`) to help contributors to choose tasks to work on. We recommend speaking to the core team on Github before starting working on an issue. You can do this by raising an issue or commenting on an existing issue. This helps us to direct your energy in directions that are aligned with our roadmap, prevent multiple people working on the same task, and better manage our board. This all makes it much more likely that your work will get merged. | ||
You can contribute anything to the IF, but we are likely to close out unsolicited PRs without merging them. Our issue board is completely open and we have tags (`core-only`, `good-first-issue`) to help contributors to choose tasks to work on. If an issue is unassigned and does not have the `core-only` label, it is available to work on. We recommend speaking to the core team on Github before starting working on an issue. You can do this by commenting on an existing issue or discussion thread or starting a new one if appropriate. This helps us to direct your energy in directions that are aligned with our roadmap, prevent multiple people working on the same task, and better manage our board. This all makes it much more likely that your work will get merged. | ||
|
||
You can also contribute by participating in discussions on our mailing list at [[email protected]](https://groups.google.com/u/1/a/greensoftware.foundation/g/if-community). We send out weekly updates that includes what we've shipped, what we're working on and how you can get involved each week. | ||
|
||
## Reporting bugs | ||
|
||
We appreciate bug reports! If you experience an issue with IF or one of our plugins, you can report it using our bug reporting template. To do this: | ||
We appreciate bug reports! If you experience an issue with IF, you can report it using our bug reporting template. To do this: | ||
|
||
1. Go to the [IF repository](https://github.com/Green-Software-Foundation/if) (or [plugin repository](https://github.com/Green-Software-Foundation/if-plugins) if you bug relates to a specific plugin) | ||
1. Go to the [IF repository](https://github.com/Green-Software-Foundation/if) | ||
2. Click on the `Issues` tab | ||
3. Click on `Create New Issue` and select the `Bug Report` template. | ||
4. Fill out the requested information. | ||
|
@@ -46,8 +46,7 @@ The assessment rubric is as follows: | |
| | Consequence | Severity | | ||
| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -------- | | ||
| Bugs in IF core leading to incorrect calculations | unusable framework | 5 | | ||
| Bugs in if-plugins leading to incorrect calculations | core pathways fail, IF very limited in functionality | 5 | | ||
| Bugs in if-unofficial-pluginsd leading to incorrect calculations | Third party plugins harder to use, limits IF to standard lib | 3 | | ||
| Bugs in builtins leading to incorrect calculations | core pathways fail, IF very limited in functionality | 5 | | ||
| Bugs in template | Harder to build plugins, ecosystem growth is impacted | 2 | | ||
| Bugs in docs | product does not match expectation, hard to debug, frustration, loss of adoption | 2 | | ||
| Security flaw: privacy related | leak user data, unlikely to achieve adoption in serious orgs | 5 | | ||
|