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

Issue templates #17

Closed
wants to merge 15 commits into from
Closed
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
32 changes: 32 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Change Summary

## Overview
<!--Add a list or paragraph giving an overview of your changes-->

## New Dependencies
<!--List any new dependencies introduced by these changes-->

## New Files
<!--List each new file and add bullets to describe the purpose/function of the new file.
This should be high level, but enough detail for the reviewer to understand what purpose(s) the
code in the file is serving-->
- new file 1
- description of new file 1's purpose

## Deleted Files
<!--List each deleted file and add one or more bullets with the rationale for why the file is being deleted-->
- deleted file 1
- explanation for why file was deleted

## Updated Files
<!--List each updated file and add bullets to describe the purpose/function of the updates.
This should be high level, but enough detail for the reviewer to understand what purpose(s) the
updated code in the file is serving-->
- updated file 1
- description of change 1 in file 1
- description of change 2 in file 2
- updated file 2
- descipriton of change 1 in file 2

## Testing
<!--List any relevant testing information like number of unit tests added, any new tests being skipped and the reason why, etc.-->
102 changes: 102 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# `imap_processing` Code of Conduct

## Introduction

This code of conduct applies to all spaces related to the `imap_processing`
project, including all public and private mailing lists, repositories, issue
trackers, wikis, and any other communication channel used by our community.

This code of conduct should be honored by everyone who participates in the
project formally or informally, or claims any affiliation with the project, in
any project-related activities and especially when representing the project, in
any role.

This code is not exhaustive or complete. It serves to distill our common
understanding of a collaborative, shared environment and goals. Please try to
follow this code in spirit as much as in letter, to create a friendly and
productive environment that enriches the surrounding community.

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

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

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
39 changes: 39 additions & 0 deletions Open_issue_TEMPLATE.md.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<html>
<head>
<title>Open_issue_TEMPLATE.md</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
.s0 { color: #cc7832;}
.s1 { color: #a9b7c6;}
.s2 { color: #a9b7c6;}
.s3 { color: #6a8759;}
</style>
</head>
<body bgcolor="#2b2b2b">
<table CELLSPACING=0 CELLPADDING=5 COLS=1 WIDTH="100%" BGCOLOR="#606060" >
<tr><td><center>
<font face="Arial, Helvetica" color="#000000">
Open_issue_TEMPLATE.md</font>
</center></td></tr></table>
<pre><span class="s0">### </span><span class="s2">Topic</span><span class="s1">:</span>

<span class="s0">### </span><span class="s2">Description</span><span class="s1">:</span>

<span class="s0">### </span><span class="s2">Requirements</span>

<span class="s0">&gt; </span><span class="s1">**</span><span class="s2">Specify</span><span class="s1">: (</span><span class="s2">optional</span><span class="s1">)**</span>

<span class="s0">### </span><span class="s2">Code Snippet </span><span class="s1">(</span><span class="s2">optional</span><span class="s1">):</span>

<span class="s3">```python</span>
<span class="s3"># Code</span>
<span class="s3">```</span>

<span class="s0">### </span><span class="s2">Related </span><span class="s1">(</span><span class="s2">optional</span><span class="s1">):</span>

<span class="s0">### </span><span class="s2">Follow up comments</span><span class="s1">:</span>


</pre>
</body>
</html>
25 changes: 25 additions & 0 deletions imap_processing/decom.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
from space_packet_parser import parser, xtcedef


def decom_packets(packet_file: str, xtce_packet_definition: str):
"""Unpack CCSDS data packet. In this function, we unpack and return data
as it is. Data modification will not be done at this step.

Parameters
----------
packet_file : str
Path to data packet path with filename
xtce_packet_definition : str
Path to XTCE file with filename

Returns
-------
List
List of all the unpacked data
"""
packet_definition = xtcedef.XtcePacketDefinition(xtce_packet_definition)
packet_parser = parser.PacketParser(packet_definition)

with open(packet_file, "rb") as binary_data:
packet_generator = packet_parser.generator(binary_data)
return list(packet_generator)
Loading