diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c919a7cc8974af65fd8efc43322426e0d7e0c052..50f80bee9652994a74a002ce8ee23790e0e8b22a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ Write a patch Help yourself with the [documentation](http://docs.weboob.org/). -Find an opened issue on [this website](https://git.weboob.org/weboob/devel/issues), +Find an opened issue on [this website](https://git.weboob.org/weboob/weboob/issues), or write your own bugfix or feature. Then, once it is necessary, commit with: $ git commit -a @@ -36,7 +36,7 @@ You can run these scripts to be sure your patch doesn't break anything: $ tools/run_tests.sh yourmodulename # or without yourmodulename to test everything Perhaps you should also write or fix tests. These tests are automatically run by -[Gitlab CI](https://git.weboob.org/weboob/devel/pipelines) at each commit and merge requests. +[Gitlab CI](https://git.weboob.org/weboob/weboob/pipelines) at each commit and merge requests. Create a merge request or send a patch @@ -68,11 +68,11 @@ merge a MR. Anyone is welcome to review and comment pending merge requests. A merge request should in principle have at least two reviewers before getting merged. -Weboob `devel` repo should keep an history as linear as possible. Then, -merging a merge request should be done locally, with prior rebasing upon the -`master` branch and take care of using the `-ff-only` merge option. Merge -requests should **NOT** be merged through the Gitlab UI, which would result in -an extra "merge" commit. +Weboob repo should keep an history as linear as possible. Then, merging a merge +request should be done locally, with prior rebasing upon the `master` branch +and take care of using the `-ff-only` merge option. Merge requests should +**NOT** be merged through the Gitlab UI, which would result in an extra "merge" +commit. Getting your contribution accepted diff --git a/docs/source/_templates/indexsidebar.html b/docs/source/_templates/indexsidebar.html index fc111e28a3faa52b4313bff2726d6e367bd6193b..ab5dfd30b7ba7d445745dcfac091974d11e0607f 100644 --- a/docs/source/_templates/indexsidebar.html +++ b/docs/source/_templates/indexsidebar.html @@ -1,6 +1,6 @@

Other resources

diff --git a/docs/source/guides/contribute.rst b/docs/source/guides/contribute.rst index 429b29f831d8436cd8c10ab44230706285e41adb..4a8a69b507dca3a7ce8447f5f853a2d69ed67742 100644 --- a/docs/source/guides/contribute.rst +++ b/docs/source/guides/contribute.rst @@ -9,7 +9,7 @@ Write a patch Help yourself with the `documentation `_. -Find an opened issue on `this website `_, or write your own bugfix or feature. +Find an opened issue on `this website `_, or write your own bugfix or feature. Then, once it is necessary, commit with:: $ git commit -a @@ -31,7 +31,7 @@ To aid in verifying Python 3 compatibility, also run:: $ tools/run_tests.sh -3 yourmodulename Perhaps you should also write or fix tests. These tests are automatically run by -`Gitlab CI `_ at each commit and merge requests. +`Gitlab CI `_ at each commit and merge requests. Create a merge request or send a patch -------------------------------------- diff --git a/docs/source/guides/setup.rst b/docs/source/guides/setup.rst index 326856c8614527cdf172a3c55adca4de74cf29b2..5e17193a43158de8f481f6f07edf6400d12fbca2 100644 --- a/docs/source/guides/setup.rst +++ b/docs/source/guides/setup.rst @@ -8,7 +8,7 @@ Git installation Clone a git repository with this command:: - $ git clone https://git.weboob.org/weboob/devel.git + $ git clone https://git.weboob.org/weboob/weboob.git We don't want to install Weboob on the whole system, so we create local directories where we will put symbolic links to sources:: diff --git a/docs/source/guides/tests.rst b/docs/source/guides/tests.rst index 309ba2f33dcd0e2e13635db17d50fe7672865ab2..32a8daf86fdf037b0f9c51d9445f2e5d8be89f56 100644 --- a/docs/source/guides/tests.rst +++ b/docs/source/guides/tests.rst @@ -21,7 +21,7 @@ Then, it run every method which name starts with ``test_``. .. note:: Some environment variables are available, to use specific backend file or send the test results. Refer to `the - comments in the script `_ for more infos on this. + comments in the script `_ for more infos on this. If a module name is passed as argument, only this module will be tested. For example, to only run ``lutim`` tests::