birdsopensource/birds3-com

Documentation for the communications board used in the BIRDS3 Satellite

BIRDS3-COM

Documentation for the communications board used in the BIRDS3 Satellite

About the BIRDS3 Program:

The project was led by Kyushu Institute of Technology in Japan and involves students from Sri Lanka, Bhutan, Nepal and Japan. Satellite Names: NepaliSat-1 (Nepal), Raavana-1 (Sri Lanka) and Ugiusu (Japan)

Stakeholders: Nepal Academy of Science and Technology (NAST) for Nepal, Arthur C Clarke Institute for Modern Technologies (ACCIMT) for Sri Lanka, and Kyushu Institute of Technology (Kyutech) for Japan.

Project duration: 2018-2020

CubeSat: 1U (10x10x10) cm3

Weight: 1.13kg

Launch Date: 17th April 2019

BIRDS-3 has 4 main missions in total; LoRa Demonstration Mission (LDM), Imaging Mission (CAM), Attitude Determination and Control Mission (ADCS) and Software Configurable Backplane Mission (BPB)

Organisation structure

Features

I like this project, can I help you?

You are welcome 🙂

• Give us a star ⭐
• Watch repository to be notified about updates 👀
• If you will find some errors, report them in Issues 🐞
• Try Birds designs on some real computer and let us know how it worked in Discussions. 💬
• We would greatly appreciate if you would also tell others about this ecosystem, it helps us to improve BIRDS Open Source. Thank you!

birds3-com's Issues

add CONTRIBUTING section to README

Supposing the contributing guidelines have already been created, we need to improve the readme to link to that information

If it has not yet been created check issue #5 and tackle that first

USE THE FOLLOWING WRITEUP AND ADAPT ACCORDINGLY THEN ADD TO THE END OF THE README

Contributing
The main purpose of this repository is to continue evolving React core, making it faster and easier to use. Development of React happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving React.

Code of Conduct
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide
Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to React.

Good First Issues
To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started.

License
React is MIT licensed.

Add to Organisation structure in readme

create a visualisation of organisational structure of this repo similar to the one here

https://github.com/BIRDSOpenSource/BIRDS3-ProceduresAndReports

and add to the Organisation Structure section

my method is a bit long, maybe you can find an alternative

1. install trees in your cli
2. type the following command to print a list of the files in the repo gh api '/repos/BIRDSOpenSource/BIRDS3-COM/git/trees/main?recursive=true' -q '.tree[]|.path'
3. copy list into a blank txt file and save
4. use this python code to display the visualisation of the files

import os

# Read paths from a file
with open('b3prpaths.txt', 'r') as f:
    paths = [line.strip() for line in f.readlines()]


# Sample list of paths (replace this with the output from your command)
# paths = [
#     "src/main/java/com/example/App.java",
#     "src/main/resources/config.yml",
#     "src/test/java/com/example/AppTest.java",
#     "docs/README.md",
#     "docs/INSTALL.md"
# ]

def build_tree(paths):
    tree = {}
    for path in paths:
        parts = path.split('/')
        current = tree
        for part in parts:
            if part not in current:
                current[part] = {}
            current = current[part]
    return tree

def print_tree(tree, prefix=''):
    keys = sorted(tree.keys())
    for index, key in enumerate(keys):
        if index == len(keys) - 1:
            print(prefix + '└── ' + key)
            new_prefix = prefix + '    '
        else:
            print(prefix + '├── ' + key)
            new_prefix = prefix + '│   '
        print_tree(tree[key], new_prefix)

# Build the tree from paths
tree = build_tree(paths)

# Print the tree
print_tree(tree)

6. copy the results on the CLI and paste in the Organisational structure section (remove specific files, the tree should only show folder levels)

Add code of conduct

Add COC page based on this https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

can be direct copy and paste or adaptation

include attribution at the end

Add "Join our Monthly Community Webinars" badge to readme

Replace the hyperlink in the top of the readme with a more visually appealing badge.

to keep all readmes of all repos looking uniform, they will have the same structure, if you can just copy the same badge here https://github.com/BIRDSOpenSource/BIRDS3-ProceduresAndReports that would be great

add contributing guidelines to repo

TAKE INSPIRATION FROM THE FOLLOWING WRITEUP AND ADAPT ACCORDINGLY

Contributing
The main purpose of this repository is to continue evolving React core, making it faster and easier to use. Development of React happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving React.

Contributing Guide
Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to React.