From 25f147a77edbe371b8fbdd267c61b1e4465b511d Mon Sep 17 00:00:00 2001 From: manu Date: Tue, 27 Aug 2024 17:07:05 +0200 Subject: [PATCH 1/8] Removing CONTRIBUTING.rst symlink --- doc/source/dev_guide/CONTRIBUTING.rst | 1 - 1 file changed, 1 deletion(-) delete mode 120000 doc/source/dev_guide/CONTRIBUTING.rst diff --git a/doc/source/dev_guide/CONTRIBUTING.rst b/doc/source/dev_guide/CONTRIBUTING.rst deleted file mode 120000 index ac9338fc25..0000000000 --- a/doc/source/dev_guide/CONTRIBUTING.rst +++ /dev/null @@ -1 +0,0 @@ -../../../CONTRIBUTING.rst \ No newline at end of file From f01b57bccfb1daa6dce06d9c55a9ec28529ceb1c Mon Sep 17 00:00:00 2001 From: manu Date: Tue, 27 Aug 2024 17:08:13 +0200 Subject: [PATCH 2/8] Adding new CONTRIBUTING.rst file. --- doc/source/dev_guide/CONTRIBUTING.rst | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 doc/source/dev_guide/CONTRIBUTING.rst diff --git a/doc/source/dev_guide/CONTRIBUTING.rst b/doc/source/dev_guide/CONTRIBUTING.rst new file mode 100644 index 0000000000..7cea977c4d --- /dev/null +++ b/doc/source/dev_guide/CONTRIBUTING.rst @@ -0,0 +1,2 @@ +.. include:: ../../../CONTRIBUTING.rst + From 279a1033be5206a7875c48b4e6da4072090b0b47 Mon Sep 17 00:00:00 2001 From: administrator Date: Tue, 27 Aug 2024 17:12:25 +0200 Subject: [PATCH 3/8] Adding my name to authors.md --- AUTHORS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/AUTHORS.md b/AUTHORS.md index 22ec5de7e4..d7e78eecae 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -67,6 +67,7 @@ The following people have made contributions to this project: - [Lars Ørum Rasmussen (loerum)](https://github.com/loerum) - [Martin Raspaud (mraspaud)](https://github.com/mraspaud) - [William Roberts (wroberts4)](https://github.com/wroberts4) +- [Emmanuel Roche (roche-emmanuel)](https://github.com/roche-emmanuel) - [Benjamin Rösner (BENR0)](https://github.com/BENR0) - [Pascale Roquet (roquetp)](https://github.com/roquetp) - [Kristian Rune Larsen](https://github.com/) From f6ba9a89be3469cd48bed92a09868b2b1382ad82 Mon Sep 17 00:00:00 2001 From: GMV - Emmanuel Roche Date: Tue, 27 Aug 2024 17:24:32 +0200 Subject: [PATCH 4/8] Applying fixes to README and CONTRIBUTING.rst --- README | 2 +- doc/source/dev_guide/CONTRIBUTING.rst | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/README b/README index 92cacd2853..a1320b1b4a 120000 --- a/README +++ b/README @@ -1 +1 @@ -README.rst \ No newline at end of file +README.rst diff --git a/doc/source/dev_guide/CONTRIBUTING.rst b/doc/source/dev_guide/CONTRIBUTING.rst index 7cea977c4d..b1cd2f37dc 100644 --- a/doc/source/dev_guide/CONTRIBUTING.rst +++ b/doc/source/dev_guide/CONTRIBUTING.rst @@ -1,2 +1 @@ .. include:: ../../../CONTRIBUTING.rst - From a25f056e745d172df8448fc806ee1e77203546d8 Mon Sep 17 00:00:00 2001 From: GMV - Emmanuel Roche Date: Tue, 27 Aug 2024 21:53:51 +0200 Subject: [PATCH 5/8] Updated contributing.rst content location. --- CONTRIBUTING.rst | 150 +------------------------- doc/source/dev_guide/CONTRIBUTING.rst | 149 ++++++++++++++++++++++++- 2 files changed, 151 insertions(+), 148 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0474f5f9b5..4cb160f8bd 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,148 +1,4 @@ -================= -How to contribute -================= +.. If reading this .rst file as plain text please refer directly + to the file included below for contribution guidelines. -Thank you for considering contributing to Satpy! Satpy's development team -is made up of volunteers so any help we can get is very appreciated. - -Contributions from users are what keep this community going. We welcome -any contributions including bug reports, documentation fixes or updates, -bug fixes, and feature requests. By contributing to Satpy you are providing -code that everyone can use and benefit from. - -The following guidelines will describe how the Satpy project structures -its code contributions from discussion to code to package release. - -For more information on contributing to open source projects see -`GitHub's Guide `_. - -What can I do? -============== - -- Make sure you have a `GitHub account `_. -- Submit a ticket for your issue, assuming one does not already exist. -- If you're uncomfortable using Git/GitHub, see - `Learn Git Branching `_ or other - online tutorials. -- If you are uncomfortable contributing to an open source project see: - - * `How to Contribute to an Open Source Project on GitHub `_ - video series - * Aaron Meurer's `Git Workflow `_ - * `How to Contribute to Open Source `_ - -- See what `issues `_ already - exist. Issues marked - `good first issue `_ - or `help wanted `_ - can be good issues to start with. -- Read the :doc:`index` for more details on contributing code. -- `Fork `_ the repository on - GitHub and install the package in development mode. -- Update the Satpy documentation to make it clearer and more detailed. -- Contribute code to either fix a bug or add functionality and submit a - `Pull Request `_. -- Make an example Jupyter Notebook and add it to the - `available examples `_. - -What if I break something? -========================== - -Not possible. If something breaks because of your contribution it was our -fault. When you submit your changes to be merged as a GitHub -`Pull Request `_ -they will be automatically tested and checked against coding style rules. -Before they are merged they are reviewed by at least one maintainer of the -Satpy project. If anything needs updating, we'll let you know. - -What is expected? -================= - -You can expect the Satpy maintainers to help you. We are all volunteers, -have jobs, and occasionally go on vacations. We will try our best to answer -your questions as soon as possible. We will try our best to understand your -use case and add the features you need. Although we strive to make -Satpy useful for everyone there may be some feature requests that we can't -allow if they would require breaking existing features. Other features may -be best for a different package, PyTroll or otherwise. Regardless, we will -help you find the best place for your feature and to make it possible to do -what you want. - -We, the Satpy maintainers, expect you to be patient, understanding, and -respectful of both developers and users. Satpy can only be successful if -everyone in the community feels welcome. We also expect you to put in as -much work as you expect out of us. There is no dedicated PyTroll or Satpy -support team, so there may be times when you need to do most of the work -to solve your problem (trying different test cases, environments, etc). - -Being respectful includes following the style of the existing code for any -code submissions. Please follow -`PEP8 `_ style guidelines and -limit lines of code to 80 characters whenever possible and when it doesn't -hurt readability. Satpy follows -`Google Style Docstrings `_ -for all code API documentation. When in doubt use the existing code as a -guide for how coding should be done. - -.. _dev_help: - -How do I get help? -================== - -The Satpy developers (and all other PyTroll package developers) monitor the: - -- `Mailing List `_ -- `Slack chat `_ (get an `invitation `_) -- `GitHub issues `_ - -How do I submit my changes? -=========================== - -Any contributions should start with some form of communication (see above) to -let the Satpy maintainers know how you plan to help. The larger the -contribution the more important direct communication is so everyone can avoid -duplicate code and wasted time. -After talking to the Satpy developers any additional work like code or -documentation changes can be provided as a GitHub -`Pull Request `_. - -To make sure that your code complies with the pytroll python standard, you can -run the `flake8 `_ linter on your changes -before you submit them, or even better install a pre-commit hook that runs the -style check for you. To this aim, we provide a configuration file for the -`pre-commit `_ tool, that you can install with eg:: - - pip install pre-commit - pre-commit install - -running from your base satpy directory. This will automatically check code style for every commit. - -Code of Conduct -=============== - -Satpy follows the same code of conduct as the PyTroll project. For reference -it is copied to this repository in -`CODE_OF_CONDUCT.md `_. - -As stated in the PyTroll home page, this code of conduct applies to the -project space (GitHub) as well as the public space online and offline when -an individual is representing the project or the community. Online examples -of this include the PyTroll Slack team, mailing list, and the PyTroll twitter -account. This code of conduct also applies to in-person situations like -PyTroll Contributor Weeks (PCW), conference meet-ups, or any other time when -the project is being represented. - -Any violations of this code of conduct will be handled by the core maintainers -of the project including David Hoese, Martin Raspaud, and Adam Dybbroe. -If you wish to report one of the maintainers for a violation and are -not comfortable with them seeing it, please contact one or more of the other -maintainers to report the violation. Responses to violations will be -determined by the maintainers and may include one or more of the following: - -- Verbal warning -- Ask for public apology -- Temporary or permanent ban from in-person events -- Temporary or permanent ban from online communication (Slack, mailing list, etc) - -For details see the official -`code of conduct document `_. +.. include:: doc/source/dev_guide/CONTRIBUTING.rst diff --git a/doc/source/dev_guide/CONTRIBUTING.rst b/doc/source/dev_guide/CONTRIBUTING.rst index b1cd2f37dc..0474f5f9b5 100644 --- a/doc/source/dev_guide/CONTRIBUTING.rst +++ b/doc/source/dev_guide/CONTRIBUTING.rst @@ -1 +1,148 @@ -.. include:: ../../../CONTRIBUTING.rst +================= +How to contribute +================= + +Thank you for considering contributing to Satpy! Satpy's development team +is made up of volunteers so any help we can get is very appreciated. + +Contributions from users are what keep this community going. We welcome +any contributions including bug reports, documentation fixes or updates, +bug fixes, and feature requests. By contributing to Satpy you are providing +code that everyone can use and benefit from. + +The following guidelines will describe how the Satpy project structures +its code contributions from discussion to code to package release. + +For more information on contributing to open source projects see +`GitHub's Guide `_. + +What can I do? +============== + +- Make sure you have a `GitHub account `_. +- Submit a ticket for your issue, assuming one does not already exist. +- If you're uncomfortable using Git/GitHub, see + `Learn Git Branching `_ or other + online tutorials. +- If you are uncomfortable contributing to an open source project see: + + * `How to Contribute to an Open Source Project on GitHub `_ + video series + * Aaron Meurer's `Git Workflow `_ + * `How to Contribute to Open Source `_ + +- See what `issues `_ already + exist. Issues marked + `good first issue `_ + or `help wanted `_ + can be good issues to start with. +- Read the :doc:`index` for more details on contributing code. +- `Fork `_ the repository on + GitHub and install the package in development mode. +- Update the Satpy documentation to make it clearer and more detailed. +- Contribute code to either fix a bug or add functionality and submit a + `Pull Request `_. +- Make an example Jupyter Notebook and add it to the + `available examples `_. + +What if I break something? +========================== + +Not possible. If something breaks because of your contribution it was our +fault. When you submit your changes to be merged as a GitHub +`Pull Request `_ +they will be automatically tested and checked against coding style rules. +Before they are merged they are reviewed by at least one maintainer of the +Satpy project. If anything needs updating, we'll let you know. + +What is expected? +================= + +You can expect the Satpy maintainers to help you. We are all volunteers, +have jobs, and occasionally go on vacations. We will try our best to answer +your questions as soon as possible. We will try our best to understand your +use case and add the features you need. Although we strive to make +Satpy useful for everyone there may be some feature requests that we can't +allow if they would require breaking existing features. Other features may +be best for a different package, PyTroll or otherwise. Regardless, we will +help you find the best place for your feature and to make it possible to do +what you want. + +We, the Satpy maintainers, expect you to be patient, understanding, and +respectful of both developers and users. Satpy can only be successful if +everyone in the community feels welcome. We also expect you to put in as +much work as you expect out of us. There is no dedicated PyTroll or Satpy +support team, so there may be times when you need to do most of the work +to solve your problem (trying different test cases, environments, etc). + +Being respectful includes following the style of the existing code for any +code submissions. Please follow +`PEP8 `_ style guidelines and +limit lines of code to 80 characters whenever possible and when it doesn't +hurt readability. Satpy follows +`Google Style Docstrings `_ +for all code API documentation. When in doubt use the existing code as a +guide for how coding should be done. + +.. _dev_help: + +How do I get help? +================== + +The Satpy developers (and all other PyTroll package developers) monitor the: + +- `Mailing List `_ +- `Slack chat `_ (get an `invitation `_) +- `GitHub issues `_ + +How do I submit my changes? +=========================== + +Any contributions should start with some form of communication (see above) to +let the Satpy maintainers know how you plan to help. The larger the +contribution the more important direct communication is so everyone can avoid +duplicate code and wasted time. +After talking to the Satpy developers any additional work like code or +documentation changes can be provided as a GitHub +`Pull Request `_. + +To make sure that your code complies with the pytroll python standard, you can +run the `flake8 `_ linter on your changes +before you submit them, or even better install a pre-commit hook that runs the +style check for you. To this aim, we provide a configuration file for the +`pre-commit `_ tool, that you can install with eg:: + + pip install pre-commit + pre-commit install + +running from your base satpy directory. This will automatically check code style for every commit. + +Code of Conduct +=============== + +Satpy follows the same code of conduct as the PyTroll project. For reference +it is copied to this repository in +`CODE_OF_CONDUCT.md `_. + +As stated in the PyTroll home page, this code of conduct applies to the +project space (GitHub) as well as the public space online and offline when +an individual is representing the project or the community. Online examples +of this include the PyTroll Slack team, mailing list, and the PyTroll twitter +account. This code of conduct also applies to in-person situations like +PyTroll Contributor Weeks (PCW), conference meet-ups, or any other time when +the project is being represented. + +Any violations of this code of conduct will be handled by the core maintainers +of the project including David Hoese, Martin Raspaud, and Adam Dybbroe. +If you wish to report one of the maintainers for a violation and are +not comfortable with them seeing it, please contact one or more of the other +maintainers to report the violation. Responses to violations will be +determined by the maintainers and may include one or more of the following: + +- Verbal warning +- Ask for public apology +- Temporary or permanent ban from in-person events +- Temporary or permanent ban from online communication (Slack, mailing list, etc) + +For details see the official +`code of conduct document `_. From dcf3d2a5da2d4ba491b9c505560dbb34740932e9 Mon Sep 17 00:00:00 2001 From: GMV - Emmanuel Roche Date: Tue, 27 Aug 2024 22:02:24 +0200 Subject: [PATCH 6/8] Adding link in contributing.rst --- CONTRIBUTING.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4cb160f8bd..0eb7120a14 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,4 +1,12 @@ -.. If reading this .rst file as plain text please refer directly - to the file included below for contribution guidelines. +Contributing Guidelines +======================= + +For detailed contribution guidelines, please see our `Developer's Guide on Contributing `_. + +.. note:: + If you're viewing this file on GitHub, you can access the full contribution guidelines by clicking the link above. + +.. If you're reading this file locally or in a context where file inclusions are supported, + the following include statement will display the guidelines below: .. include:: doc/source/dev_guide/CONTRIBUTING.rst From b5d2f5126ab3ef7bfa34527fd4f07f3b478b6c0e Mon Sep 17 00:00:00 2001 From: GMV - Emmanuel Roche Date: Wed, 28 Aug 2024 08:33:54 +0200 Subject: [PATCH 7/8] Updating contributing.rst content --- CONTRIBUTING.rst | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0eb7120a14..44d272b198 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,12 +1,9 @@ Contributing Guidelines ======================= -For detailed contribution guidelines, please see our `Developer's Guide on Contributing `_. +For detailed contribution guidelines, please see our `Developer's Guide on ReadTheDocs `_. -.. note:: - If you're viewing this file on GitHub, you can access the full contribution guidelines by clicking the link above. -.. If you're reading this file locally or in a context where file inclusions are supported, - the following include statement will display the guidelines below: - -.. include:: doc/source/dev_guide/CONTRIBUTING.rst +.. If you're reading this file locally as a plain text, you may also + directly refer to the file doc/source/dev_guide/CONTRIBUTING.rst for + any unmerged/pending changes to the contribution guidelines. From 92153226e5feb1bf343444df1d5dea38a532d580 Mon Sep 17 00:00:00 2001 From: GMV - Emmanuel Roche Date: Wed, 28 Aug 2024 20:40:54 +0200 Subject: [PATCH 8/8] Removing README element --- README | 1 - 1 file changed, 1 deletion(-) delete mode 120000 README diff --git a/README b/README deleted file mode 120000 index a1320b1b4a..0000000000 --- a/README +++ /dev/null @@ -1 +0,0 @@ -README.rst