-
Notifications
You must be signed in to change notification settings - Fork 1
Create charter.md #1
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
Open
lisancao
wants to merge
2
commits into
opea-project:main
Choose a base branch
from
lisancao:charter-update
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Developer Experience Working Group Charter for the OPEA Project | ||
|
|
||
| The Developer Experience Working Group (DXWG) is established to enhance and streamline the developer experience across all stages of the software development lifecycle within our organization. The DXWG aims to identify, prioritize, and implement improvements that will foster a more productive, efficient, and satisfying environment for developers. By focusing on tools, processes, documentation, and culture, the DXWG will drive initiatives that remove friction, reduce cognitive load, and enable developers to focus on building high-quality software. | ||
|
|
||
| ## 1. Mission and Scope of the Project | ||
|
|
||
| ### Mission | ||
|
|
||
| 1. The working group's mission is to set up frameworks, tools, and processes by which contributors, developers, and users of the OPEA project can succeed. | ||
| 2. To continuously improve and facilitate developer productivity, collaboration, effectiveness, knowledge sharing, feedback, and innovation through automation and integration tools, documentation, and process optimization. | ||
|
|
||
| ### Scope | ||
|
|
||
| The OPEA Developer Experience Working Group is concerned with: | ||
|
|
||
| * **Tools and Infrastructure:** Evaluate and recommend tools, technologies, and infrastructure improvements that simplify development workflows, improve integration, and enhance overall developer productivity. E.g. Code editors, IDEs, version control systems, CI/CD tools, and other development platforms. | ||
|
|
||
| * **Process Optimization:** Identify and streamline processes, such as code reviews, CI/CD pipelines, and deployment practices, to reduce bottlenecks and increase development velocity. E.g. Code reviews, testing practices, deployment strategies, and incident management. | ||
|
|
||
| * **Documentation:** Ensure that documentation is comprehensive, up-to-date, and easily accessible. Foster a culture of knowledge sharing and collaboration through internal documentation, wikis, and developer forums. E.g. API documentation, internal guides, and best practices. | ||
|
|
||
| * **Developer Onboarding:** Improve the onboarding experience for new developers by creating clear, concise onboarding materials and processes that accelerate their integration into the team and organization. E.g. Onboarding manuals and Developer Meetups. | ||
|
|
||
| ## 2. Membership | ||
|
|
||
| The DXWG will consist of members from various teams across the organization, including but not limited to users, developers (DevOps, QA, ML, Security, Data Infrastructure, FrontEnd, BackEnd, and Full-Stack), technical writers, product managers, and stakeholders. | ||
|
|
||
| Membership is open to all individuals, both early career and senior, who are passionate about improving the developer experience and willing to contribute their time and expertise to the group. | ||
|
|
||
| ## 3. Meetings | ||
|
|
||
| The DXWG will meet bi-weekly, via Zoom, to discuss ongoing initiatives, review progress, and plan upcoming activities. Ad-hoc meetings may be scheduled as needed to address urgent issues or opportunities. | ||
|
|
||
| Meeting minutes and action items will be documented and shared with all members in a running document and shared on the LF OPEA/DX-Working-Group repository and mailing lists to ensure transparency and accountability. | ||
|
|
||
| ## 4. Compliance with Policies | ||
|
|
||
| 1. This Charter is subject to the Series Agreement for the Project and the Operating Agreement of LF Projects. Contributors will comply with the policies of LF Projects as may be adopted and amended by LF Projects, including, without limitation the policies listed at https://lfprojects.org/policies/. | ||
| 2. The DXWG may adopt a Project-specific code of conduct (“CoC”) for the Project, which is subject to approval by the Series Manager. In the event that a Project-specific CoC has not been approved, the LF Projects Code of Conduct listed at https://lfprojects.org/policies will apply for all Collaborators in the Project. | ||
| 3. When amending or adopting any policy applicable to the Project, LF Projects will publish such policy, as to be amended or adopted, on its web site at least 30 days prior to such policy taking effect; provided, however, that in the case of any amendment of the Trademark Policy or Terms of Use of LF Projects, any such amendment is effective upon publication on LF Project’s web site. | ||
| 4. All Collaborators must allow open participation from any individual or organization meeting the requirements for contributing under this Charter and any policies adopted for all Collaborators by the DXWG, regardless of competitive interests. Put another way, the Project community must not seek to exclude any participant based on any criteria, requirement, or reason other than those that are reasonable and applied on a non-discriminatory basis to all Collaborators in the Project community. | ||
| 5. The Project will operate in a transparent, open, collaborative, and ethical manner at all times. The output of all Project discussions, proposals, timelines, decisions, and status should be made open and easily visible to all. Any potential violations of this requirement should be reported immediately to the Series Manager. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is the difference between contributor and developer? Perhaps keep just developer and that matches the WG name too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Contributors, in my mind, could be writers as well...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinking of writers as well but I agree it can be a little redundant.