28 Commits

Author SHA1 Message Date
Shelly Coen
02fe8d58f9 Update CONTRIBUTING.md with Shelly's Info 2022-10-17 07:46:57 +00:00
Raphaël Mélotte
776090899a treewide: replace Netgear RAX40 with Axepoint in documentation
Note that there are still 2 mentions of "RAX40" in comments, but they
were kept because one of them is a TODO item that will be removed in
the future, and the other one is about a test that was done
specifically on a RAX40.

Fixes PPM-1720

Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be>
2021-11-30 13:10:01 +01:00
Mario Maz
83ca786423 doc: add reference to passing_agent_tests_wifi_bh.txt
https://jira.prplfoundation.org/browse/PPM-859

Update the "Definition of done" in CONTRIBUTING.md to reference the just
created file `passing_agent_tests_wifi_bh.txt`.

Signed-off-by: Mario Maz <mmazzapater@gmail.com>
2020-12-17 14:48:11 +01:00
Arnout Vandecappelle (Essensium/Mind)
016534559b CONTRIBUTING: relax requirement on non-breaking commits
There was some discussion about the rule that a commit should never
break anything. It turns out that this rule is not that important after
all (since we've never used git bisect up to now), and in some cases it
makes our life a lot easier if a braking commit is allowed. Also, some
MRs have had breaking commits already, and there wasn't a big problem.

Therefore, relax the constraint about non-breaking commits a bit, with
an explanation why.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2020-10-12 09:17:51 +02:00
Frederik Van Bogaert
c442d20295 documentation: CONTRIBUTING.md: change WIP into Draft
Signed-off-by: Frederik Van Bogaert <frederik.vanbogaert@mind.be>
2020-08-25 11:31:06 +02:00
Frederik Van Bogaert
c735b6fde6 documentation: CONTRIBUTING.md: remove obsolete lines
Implement review feedback:
* Remove obsolete lines regarding "ready for merge" and "don't merge" labels
* Remove reference to pull requests
* Fix URL

See PPM-335

Signed-off-by: Frederik Van Bogaert <frederik.vanbogaert@mind.be>
2020-08-25 11:31:06 +02:00
Frederik Van Bogaert
0c6484249b documentation: Adapt CONTRIBUTING.md for the move to gitlab
This is an attempt at keeping the docs up to date with the move from github to gitlab.
Since this document will be used as a template for prplWrt as well, it's double important that it stays up to date.

I anticipate we'll need another update once the move is complete and we've settled on how to work effectively with gitlab a bit more.
The "Merge request workflow" in particular might change significantly, but I don't want to do it yet because I'm not certain yet what it will look like.
Also, I don't know how (if) the DCO check still works with gitlab, or if we need to tweak things a little there.
No doubt we'll discover other issues.

So, this is just an *initial version* of the contribution guidelines, adapted for gitlab.

See PPM-335

Signed-off-by: Frederik Van Bogaert <frederik.vanbogaert@mind.be>
2020-08-25 11:30:55 +02:00
Frederik Van Bogaert
61bd7eea49 documentation: Point to confluence iso github
I'm disabling the github wiki in favor of confluence,
    so make sure to link people to the right place.

Signed-off-by: Frederik Van Bogaert <frederik.vanbogaert@essensium.com>
2020-08-06 08:46:27 +00:00
Frederik Van Bogaert
60a0e7383f documentation: Add information about JIRA
Update CONTRIBUTING.md with information on how to tie it in with JIRA

https://jira.prplfoundation.org/browse/PPM-220

Signed-off-by: Frederik Van Bogaert <frederik.vanbogaert@essensium.com>
2020-07-09 11:59:39 +00:00
Vitaly Bukhovsky
0619c09600 docs: update documentation files
Remove MSGLIB references from the documentation files.

Signed-off-by: Vitaly Bukhovsky <vitaly@devalore.com>
2020-07-08 12:03:20 +00:00
Raphaël Mélotte
81ab60b868 CONTRIBUTING.md: definition of done: add passing_agent_tests.txt
Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be>
2020-04-21 08:00:33 +00:00
Arnout Vandecappelle (Essensium/Mind)
7f30baf146 CONTRIBUTING.md: add a paragraph about clang-format and flake8
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2020-04-15 07:14:12 +00:00
Arnout Vandecappelle (Essensium/Mind)
e4f3468b12 treewide: replace copyright statements with SPDX-FileCopyrightText
Although REUSE does not require it, it is advised to use the
SPDX-FileCopyrightText. Since we're anyway doing treewide updates here,
we can just as well do one more now.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2020-04-10 18:05:17 +00:00
Arnout Vandecappelle (Essensium/Mind)
44e9047e9e CONTRIBUTING.md: explain about AUTHORS and copyright header
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2020-04-10 18:05:17 +00:00
Arnout Vandecappelle (Essensium/Mind)
75e451eea0 CONTRIBUTING: add an example of a good pull request
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2020-03-20 17:28:53 +00:00
Arnout Vandecappelle (Essensium/Mind)
1c6a5ce71b .mergify.yml: require "ready for merge" label
Currently, a PR will be merged automatically as soon as it has two
reviews and passes CI. However, there have been a few cases where this
was a bit premature, i.e. something was still supposed to have changed.

Require an explicit "ready for merge" label to trigger automatic
merging.

Update CONTRIBUTING.md with this workflow.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2020-03-19 15:06:56 +01:00
Tomer Eliyahu
32a7df0568 CONTRIBUTING.md: add CI testing to definition of done
Until we have a capable test framework (possibly boardfarm), which will
verify each test flow on a real device, some changes can break real
devices in certification if they are not tested in a real device.
For that we have a section in the wiki which provides every developer an
easy way to run any test on his branch.
Developers who change a piece of code which may impact some
certification flow, for example changing topology handling, or
autoconfig, etc. - should be tested with the relevant test.

Signed-off-by: Tomer Eliyahu <tomer.b.eliyahu@intel.com>
2020-03-17 06:58:35 +00:00
Arnout Vandecappelle (Essensium/Mind)
81b8c8489c tests: move the rest of the flow tests to python
Convert the remaining tests to python, and remove test_flows.sh. The
remaining tests are optimal_path_dummy, client_steering_dummy,
client_steering_policy, client_association,
higher_layer_data_payload_trigger, and topology.

Since optimal_path_dummy doesn't work reliably, disable it by prepending
an underscore to the name. Also it should start with reconfiguring the
APs so each radio has a VAP with the same SSID.

Remove test_flows.sh from gitlab-ci, and rename run-tests-py to run-tests.

CONTRIBUTING.md refers to test_flows.py instead of test_flows.sh.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2020-03-16 13:50:51 +00:00
Frederik Van Bogaert
32ef5df3a3 common:tests: move tests to top level directory
Moves all tests to the top level "tests" directory

Update paths that accessed files in the tests directory
        to point to the new location.

This includes the test files itself, and some other files
        needed for CI.

Namely, .gitlab-ci.yml has been updated with new paths.

Also, the mention of those tests in CONTRIBUTING.md was fixed.

Signed-off-by: Frederik Van Bogaert <frederik.vanbogaert@essensium.com>
2020-01-27 15:34:43 +01:00
Arnout Vandecappelle (Essensium/Mind)
8f3aec1566 CONTRIBUTING.md: remove stale references to Travis
Replace with gitlab CI where appropriate.

Also add missing reference to Turris, B1300 and RAX40 builds in CI.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2020-01-27 15:34:43 +01:00
Frederik Van Bogaert
f0abf65bbd documentation: CONTRIBUTING.md: Remove mailing list, cleanup
* Remove mentions of the mailing list, which has been abandoned.
* Fix some of the URLs in the document

Signed-off-by: Frederik Van Bogaert <frederik.vanbogaert@essensium.com>
2020-01-09 13:32:15 +02:00
Arnout Vandecappelle (Essensium/Mind)
85bc9056c9 CONTRIBUTING: add explanation of "don't merge" tag
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2019-12-19 12:53:51 +02:00
Tomer Eliyahu
56afc869fd travis: replace test_gw_repeater.sh with test_flows.sh
Now that we have a full test to verify all flows, use that in travis CI.
Have travis test perform the topology test which is the only test
currently implemented. From now on, every new flow will include adding a
test to test_flows.sh and update travis accordingly.

Also update CONTRIBUTING.md accordingly.

Signed-off-by: Tomer Eliyahu <tomer.b.eliyahu@intel.com>
2019-08-12 19:21:11 +03:00
Arnout Vandecappelle (Essensium/Mind)
466e6e778b common: add coding style document
We can update this document as we decide on the coding style.

Also refer to this new document from CONTRIBUTING.md.

Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2019-07-06 11:30:55 +02:00
Tomer Eliyahu
571ae2d18a documentaion: CONTRIBUTING.md workflow adjustments
Update workflow to better describe how to work with fixup commits, when
to do rebase-force-push during review, etc.

Signed-off-by: Tomer Eliyahu <tomer.b.eliyahu@intel.com>
2019-06-26 12:03:41 +03:00
Tomer Eliyahu
f27b527b2b documentation: CONTRIBUTING.md lint fixes
Fix Markdown lint problems in CONTRIBUTING.md

Signed-off-by: Tomer Eliyahu <tomer.b.eliyahu@intel.com>
2019-06-26 12:03:41 +03:00
Arnout Vandecappelle (Essensium/Mind)
7bf39a1ab9 CONTRIBUTING.md: extend the workflow section
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2019-06-25 18:14:50 +03:00
Arnout Vandecappelle (Essensium/Mind)
6f6c5fd958 documentation: add CONTRIBUTING.md
Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
2019-06-24 11:41:30 +02:00