Expectations in the source code modifications

There is several types of modifications which can be done into the source code. Each one of them has some requierements to be accepted into Scilab source tree.

General

As much as possible, each commit must be atomic. That means that any modification could be cherry-pick to an other branch out of the box.

Any modification should update the CHANGES_X.

Type of commits

New feature

This modification is the one which has the most of requierements.

  1. Write a SEP.

  2. Send a email on dev@lists.scilab.org to discuss the SEP.

  3. Write a new function in Scilab.
  4. Write the unit test (.tst) (in modules/*/tests/unit_tests)
  5. Create a reference (test_run("module_name","new_function","create_ref"))
  6. Write help page.
  7. Update build process if needed
  8. Update of the CHANGES_X

The commit comment should have a reference to the SEP number.

Bug fix

A bug fix can be also a performance improvement, an update of the documentation, etc. Please refer also to the appropriate section.

  1. The modification in the code
  2. The non regression tests
  3. Update of the CHANGES_X

See also How to close a bug in Scilab

The commit comment should have a reference to the bug number.

Performance improvement

  1. The modification in the code
  2. If possible, the code used to benchmark (stored into modules/xxx/unit_tests/benchmark)
  3. Update of the CHANGES_X if the performance gain is important

Documentation

  1. The modification in the documentation
  2. The french translation updated if already available
  3. Update of the CHANGES_X if the modification on the documentation is important

Tests

  1. The test added in the code
  2. The reference of the test (test_run("module","test","create_ref")
  3. Update of the CHANGES_X if the new test is important

Update of the build process

  1. The modification in the build process (autotools and Visual project)
  2. Update of the CHANGES_X if the modification is important

public: Expectations in the source code modifications (last edited 2012-04-04 08:18:56 by Sylvestre Ledru)