You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
SARXarray is an open-source Xarray extension for Synthetic Aperture Radar (SAR) data. It is especially designed to work with large volume complex data, e.g. Single Look Complex (SLC) data, as well as derived products such as interferogram stacks.
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
# SARXarray Contributing Guidelines
3
3
4
4
5
-
We welcome any kind of contribution to our software, from simple comment
5
+
We welcome any kind of contribution to our software, from a simple comment
6
6
or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/).
7
7
Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
8
8
@@ -16,30 +16,30 @@ The sections below outline the steps in each case.
16
16
17
17
## You have a question
18
18
19
-
- use the search functionality [here](https://github.com/MotionbyLearning/sarxarray/issues)
19
+
- use the search functionality in [GitHub issue](https://github.com/TUDelftGeodesy/sarxarray/issues)
20
20
to see if someone already filed the same issue;
21
-
- if your issue search did not yield any relevant results, make a new issue;
22
-
-apply the "question" label; apply other labels when relevant.
21
+
- if your issue search did not yield any relevant results, create a new issue;
22
+
-add the "question" label; include other labels when relevant.
23
23
24
24
## You think you may have found a bug
25
25
26
-
- use the search functionality [here](https://github.com/MotionbyLearning/sarxarray/issues) to see if someone already filed the same issue;
27
-
- if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
26
+
- use the search functionality in [GitHub issue](https://github.com/TUDelftGeodesy/sarxarray/issues) to see if someone already filed the same issue;
27
+
- if your issue search did not yield any relevant results, create a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
28
28
- the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas>) of the commit that is causing your problem;
29
29
- some identifying information (name and version number) for dependencies you're using;
30
30
- information about the operating system;
31
-
-apply relevant labels to the newly created issue.
31
+
-add relevant labels to the newly created issue.
32
32
33
33
## You want to make some kind of change to the code base
34
34
35
35
- (**important**) announce your plan to the rest of the community *before you start working*. This announcement should be in the form of a (new) issue;
36
36
- (**important**) wait until some kind of consensus is reached about your idea being a good idea;
37
-
- if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
38
-
- make sure the existing tests still work. First, install the development dependencies as `pip install .[dev]`, and then run`pytest tests`;
37
+
- if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions from GitHub: [instruction 1: configuring a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [instruction 2: syncing a fork](https://help.github.com/articles/syncing-a-fork/));
38
+
- make sure the existing tests still work by running, e.g.`pytest tests`;
39
39
- add your own tests (if necessary);
40
-
- update or expand the documentation. Make sure the documentation is built successfully: first, install documentation dependencies as `pip install .[docs]` and then run `mkdocs build`.
40
+
- update or expand the documentation;
41
41
- make sure the linting tests pass by running `ruff` in the project root directory: `ruff check .`;
42
-
-[push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the SARXarray repository on GitHub;
43
-
- create the pull request, e.g. following the instructions[here](https://help.github.com/articles/creating-a-pull-request/).
42
+
-[push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the sarxarray repository on GitHub;
43
+
- create the pull request, e.g. following [the instructions: creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
44
44
45
45
In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.
0 commit comments