Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added project folder + added issue templates + update readme #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/communication-suggestion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Communication Suggestion
description: Propose a way to better communicate a feature
title: "Communication Suggestion: "
labels: [communication]

body:
- type: markdown
attributes:
value: Thank you for taking the time to file a Communication Suggestion report.
- type: textarea
attributes:
label: Describe how we are communicating and why it is not optimal.
description: "A clear and concise description of what the problem is. Ex. When I reach this point, I cannot [...]."
- type: textarea
attributes:
label: Describe the solution you'd like.
description: "A clear and concise description of what you want to happen."
- type: textarea
attributes:
label: Describe alternatives you've considered.
description: "A clear and concise description of any alternative solutions or features you have considered."
- type: textarea
attributes:
label: Additional context.
description: "Add any other context or screenshots to clarify your suggestion here."
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Documentation Update📄
description: Suggest how we can improve our documentation
title: "Documentation📄: "
labels: [documentation]

body:
- type: markdown
attributes:
value: Thank you for taking the time to file a Documentation update report.
- type: textarea
attributes:
label: What is the current documentation state?
description: "Copy and paste the text currently in the documentation. If you want to improve graphs or photos, please provide a screenshot of the original."
- type: textarea
attributes:
label: Where is this stated?
description: "Provide additional information about the location where you have copied the above statement from."
- type: textarea
attributes:
label: Why do you want to improve the statement?
description: "Please explain why the statement needs to be updated. This can be because it is confusing, incorrect, spelling/grammatical errors, etc."
- type: textarea
attributes:
label: Proposed Statement
description: "Please propose how you would rewrite the statement. If you have a precise proposal, please make the changes and open a pull request."
- type: textarea
attributes:
label: Additional context.
description: "Add any other context or useful information about the documentation update here."
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
# user-docs
Repository to hold user docs for fossology project.
# Fossology documentation

This repository contains developer documentation for the [fossology](https://www.fossology.org/) organization.

Issues and contributions for the developer documentation are tracked here. We have a large community using these resources and we would like to make it our best effort to respond to issues in a timely fashion.