Skip to content

Commit 721bc3f

Browse files
committed
added contributing file; placed cspice retrieval back into initialize.sh for source installs
1 parent ac6b2ba commit 721bc3f

File tree

3 files changed

+36
-3
lines changed

3 files changed

+36
-3
lines changed

.github/workflows/cpp_tests.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ jobs:
1919
uses: actions/checkout@v4
2020
- name: Build GRSS library
2121
run: |
22-
cd ./extern/
23-
python3 get_cspice.py
24-
cd ..
2522
source initialize.sh
2623
source build_cpp.sh -clean
2724
- name: Run tests

contributing.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# How to contribute
2+
3+
Thanks for considering contributing to GRSS! Here are a few things to keep in mind:
4+
5+
## Contributing to the software
6+
7+
If you would like to contribute to the software, please follow these steps:
8+
9+
1. Fork the repository
10+
2. Create a new branch
11+
3. Make your changes with clear commit messages
12+
4. Submit a pull request
13+
14+
## Reporting issues or problems
15+
16+
If you encounter any issues or problems with the software, please open an issue on the repository. Be sure to include as much detail as possible, including:
17+
18+
- Steps to reproduce the issue (minimal code example whenever possible)
19+
- Expected behavior
20+
- Actual behavior
21+
- Any error messages
22+
23+
## Seeking support
24+
25+
If you need help with the software, please open an issue on the repository. Be sure to include as much detail as possible, including:
26+
27+
- A description of the problem
28+
- Any specific examples or code snippets you are requesting help with
29+
- Larger context for what you are trying to accomplish
30+
31+
I will do my best to respond to issues in a timely manner. Keep in mind that I am a single developer working on this project while completing graduate school, so I may not be able to respond immediately. Thanks for your understanding and patience!

initialize.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
# get pybind11
44
pip3 install "pybind11[global]>=2.10.0"
55

6+
# get cspice
7+
cd ./extern/
8+
python3 get_cspice.py
9+
cd ..
10+
611
# get debiasing data and kernels
712
cd grss/debias/
813
python3 get_debiasing_data.py

0 commit comments

Comments
 (0)