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 Community Files and Defined Folder Organization Structure. #6

Open
wants to merge 3 commits into
base: master
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
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Prerequisites

```Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.**```
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why surrounding most of the lines with back ticks? That way, they will appear as code snippets.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh ok. I just felt that they appear cleaner when seen in MarkDown Preview. So that's why. But sure I'll remove them. Do you want them to be removed from all the places apart from where they represent actual Code Snippets ?


- [ ] I am running the latest version
- [ ] I checked the documentation and found no answer
- [ ] I checked to make sure that this issue has not already been filed
- [ ] I'm reporting the issue to the correct repository (for multi-repository projects)
Comment on lines +5 to +8
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change these statements to questions as you mentioned above.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry. I don't think I got that properly. Like, by questions do you mean something like :

  • Are you running the latest version ?
  • Have you already checked out the documentation and were unable to find an answer ?
  • and so on . . .

Is this the expected format ?


## Expected Behavior

```Please describe the behavior you are expecting```

## Current Behavior / Question

```What is the current behavior?```

## Failure Information (for bugs)

**Remove everything after this if it is a question and not a bug report.**

```Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template.```

## Steps to Reproduce

```Please provide detailed steps for reproducing the issue.```

1. step 1
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Follow the same casing: use "Step" (with capital S).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah sure. I'll fix this.

2. step 2
3. You Get It . . .

## Context

```Please provide any relevant information about your setup.```
```This is important in case the issue is not reproducible except for under certain conditions.```

* Firmware Version:
* Operating System:
* SDK version:
* Toolchain version:
* Other Details . . .

## Failure Logs

```Please include any relevant log snippets or files here.```
35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description

``` Describe your changes in detail ```

## Motivation and Context

``` Why is this change required? What problem does it solve? ```
``` If it fixes an open issue, please link to the issue here. ```

## How has this been tested?

``` Please describe in detail how you tested your changes. ```
``` Include details of your testing environment, tests ran to see how ```
``` your change affects other areas of the code, etc. ```

## Screenshots (if appropriate):

## Types of changes

``` What types of changes does your code introduce? Put an `x` in all the boxes that apply: ```

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

## Checklist:

``` Go over all the following points, and put an `x` in all the boxes that apply. ```
``` If you're unsure about any of these, don't hesitate to ask. We're here to help! ```

- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
101 changes: 101 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Contributing to Competitive-Programming

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

All types of contributions are encouraged and valued. See the [Table of Contents](#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](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)

## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/OmarBazaraa/Competitive-Programming/blob/master/docs/README.md).

Before you ask a question, it is best to search for existing [Issues](https://github.com/OmarBazaraa/Competitive-Programming/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](https://github.com/OmarBazaraa/Competitive-Programming/issues/new)
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (compiler, OS, 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.

### Reporting Bugs

#### Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/OmarBazaraa/Competitive-Programming/blob/master/docs/README.md). If you are looking for support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/OmarBazaraa/Competitive-Programmingissues?q=label%3Abug).
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?

#### How Do I Submit a Good Bug Report?

> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead in case of sensitive bugs you can directly contact the maintainer via the provided contact details.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

- Open an [Issue](https://github.com/OmarBazaraa/Competitive-Programming/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.

Once it's filed:

- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).

> Note : Default Issues as well as Pull Request templates have already been setup, in order to guide you while opening a new Issue or PR. Kindly adhere to the default template in order to enable faster actions.

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Competitive-Programming, **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](https://github.com/OmarBazaraa/Competitive-Programming/blob/master/docs/README.md) carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://github.com/OmarBazaraa/Competitive-Programming/issues) 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](https://github.com/OmarBazaraa/Competitive-Programming/issues).

- Use a **clear and descriptive title** starting with the words ```Enhancement Proposal :``` for the issue and to help 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 appropriate screenshots** which might help you demonstrate the steps or point out the part which the suggestion is related to.
- **Explain why this enhancement would be useful** to most Competitive-Programming users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

> Note : Default Issues as well as Pull Request templates have already been setup, in order to guide you while opening a new Issue or PR. Kindly adhere to the default template in order to enable faster actions.

> Also note that in case you would like to contribute in any other manner, which has not currently been covered by this existing CONTRIBUTIONS.md file, feel free to raise an Issue. It would also help us improve our CONTRIBUTIONS guide and welcome more people to join the community.

## Attribution
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!
45 changes: 45 additions & 0 deletions ISSUE_TEMPLATES/DEFAULT_ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Prerequisites

```Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.**```

- [ ] I am running the latest version
- [ ] I checked the documentation and found no answer
- [ ] I checked to make sure that this issue has not already been filed
- [ ] I'm reporting the issue to the correct repository (for multi-repository projects)

## Expected Behavior

```Please describe the behavior you are expecting```

## Current Behavior / Question

```What is the current behavior?```

## Failure Information (for bugs)

**Remove everything after this if it is a question and not a bug report.**

```Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template.```

## Steps to Reproduce

```Please provide detailed steps for reproducing the issue.```

1. step 1
2. step 2
3. You Get It . . .

## Context

```Please provide any relevant information about your setup.```
```This is important in case the issue is not reproducible except for under certain conditions.```

* Firmware Version:
* Operating System:
* SDK version:
* Toolchain version:
* Other Details . . .

## Failure Logs

```Please include any relevant log snippets or files here.```
35 changes: 35 additions & 0 deletions PR_TEMPLATES/DEFAULT_PR_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description

``` Describe your changes in detail ```

## Motivation and Context

``` Why is this change required? What problem does it solve? ```
``` If it fixes an open issue, please link to the issue here. ```

## How has this been tested?

``` Please describe in detail how you tested your changes. ```
``` Include details of your testing environment, tests ran to see how ```
``` your change affects other areas of the code, etc. ```

## Screenshots (if appropriate):

## Types of changes

``` What types of changes does your code introduce? Put an `x` in all the boxes that apply: ```

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

## Checklist:

``` Go over all the following points, and put an `x` in all the boxes that apply. ```
``` If you're unsure about any of these, don't hesitate to ask. We're here to help! ```

- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
Loading