Skip to content

Latest commit

 

History

History
114 lines (76 loc) · 6.93 KB

CONTRIBUTING.md

File metadata and controls

114 lines (76 loc) · 6.93 KB
Raw

Contributing to Green Software Maturity Matrix

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Green Software Maturity Matrix, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  • You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most Green Software Maturity Matrix users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Editing Content

This project is a static website based on the project https://docusaurus.io, you can find more information about docusaurus here: https://docusaurus.io/docs

The docs folder contains all of the material in this project, editing any file there in the main branch will update the website. If you are only interested in editing content on the website then you should not need to leave the docs folder.

The documentation files use a format called markdown and they end in .md which supports certain basic styling features like so: https://docusaurus.io/docs/markdown-features

Developing Locally

To edit this project on your local machine and see the output as it would be rendered on the website you will need node at least version 14 installed.

We also recommend to use yarn as the package management solution as the deployment scripts use yarn not npm.

npm -g install yarn

yarn install

Then to run the project locally type

yarn run docusaurus start

and visit https://localhost:3000 in your favorite browser or whatever the command above prints out in the terminal.

Join The Project Team

Attribution

This guide is based on the contributing-gen. Make your own!