sympa-community / sympa-rest_-abandoned- Goto Github PK

The planned works are not cooperated by the committers. On the other hand, the original repository has merged the main repository repeatedly with commits added since then, making rebasing difficult. Perhaps we’d be better to rewrite from scratch.

For these reasons, abandoning this repository is suggested.

This article describes the process of initial code review on a contribution to the Sympa community.

What we will do

We will carry out the process by which people who read the code give their opinions and criticisms, and the author modifies the code accordingly.

Place of work

The code base should be placed in a separate project (repository) from the main project, sympa-community/sympa-rest.

See also "Preparation work" below.

Duration

At least six months is necessary. In addition, several months are needed to revise the code based on the results of the review.

Method

The review will be carried out in public. In practice, the GitHub issue page is used.

• Any person with an opinion, critique or the other proposals submits an issue on the project,
• Interested people discuss it,
• The authors make the necessary changes to the code according to the discussion.
• Once a consensus is reached, the issue is closed.

Preparation work

Prior to the review process, preparation work will be performed.

1. Obvious fixes of bugs and so on in the main project (sympa-community/sympa):
   => Submitted as the issues with PR on the main project.
2. Additions or extensions of Sympa's internal API (Sympa::Request::Hander modules) or the other functionalities added into the main project:
   => Submited as the issues (possiblly with PR) on the main project.
3. Remainder, i.e. additions specific to REST API (modules under Sympa::API::REST, related entries in cpanfile and tests):
   => Put in the place of work above.

Preparation work is expected to take for one to two months.

---

After a week or so, we would like to start the preparation work.