Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add development agreements documentation #7821

Closed
wants to merge 1 commit into from

Conversation

drew2a
Copy link
Collaborator

@drew2a drew2a commented Jan 15, 2024

As demonstrated in #7799, there is currently a lack of clarity regarding our processes and the agreements we have made. To address this and ensure the transfer of knowledge to future team members, I have created the agreements.rst file. This file will serve as a central repository for listing all our agreements.

I propose a single rule for this document: any changes must receive approval through pull requests from all current developers. This ensures collective agreement and maintains the integrity of our processes.

To initiate the agreements.rst with relevant content, I have included our consensus on the branching model, as discussed in the following issues:

The importance of having such a document, particularly in a distributed team with considerable turnover, cannot be overstated. Documenting agreements:

  • Facilitates Onboarding: New developers can quickly familiarize themselves with the team's methodologies, significantly reducing the learning curve.
  • Preserves Institutional Knowledge: With high turnover (the hight turnover of Tribler's developers has been shown here: Journal drew2a/ivory-tower#1 (comment)), valuable knowledge can be lost. A documented set of agreements helps preserve this knowledge, ensuring continuity and stability in the team's operations.
  • Aids in Conflict Resolution: Having a reference point for previously made agreements can significantly reduce misunderstandings and conflicts within the team, as it provides a basis for resolution and decision-making (see also: Tie Breaker #7807).
  • Ensures Continuous Improvement: By requiring unanimous approval for changes, the document becomes a living entity that evolves with the team, continually improving and adapting to new challenges and insights.

This commit adds a new file `agreements.rst` that contains the agreements made among developers. It includes information about the branching model, preferred workflow, and branch names. The document also lists related issues.

Related issues:
- Tribler#5569
- Tribler#5575
@drew2a
Copy link
Collaborator Author

drew2a commented Jan 15, 2024

As @qstokkink pointed out, the suggested file is a duplicate of an existing one: https://github.com/Tribler/tribler/blob/main/doc/contributing.rst

@drew2a drew2a closed this Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant