Skip to content

Commit 4cb2823

Browse files
jmhorcasjmhorcas
committed
Merge branch 'develop' of https://github.com/flamapy/fm_metamodel into develop
2 parents 74d210b + 3e63c89 commit 4cb2823

2 files changed

Lines changed: 267 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Contributing to Flamapy
2+
3+
Thank you for your interest in contributing to Flamapy! We welcome contributions from both individuals and organisations.
4+
5+
Flamapy is a modular framework, and contributions are essential to its development and long-term sustainability. This document describes the contribution process, release policy, licensing model, and plugin ecosystem guidelines.
6+
7+
---
8+
9+
## Contribution workflow
10+
11+
### Branching model
12+
Flamapy follows a lightweight Gitflow-inspired model:
13+
14+
- **`main`** — stable production-ready releases
15+
- **`develop`** — latest development state where contributions are integrated
16+
17+
### Pull Request process
18+
1. Fork the repository and create a branch based on **`develop`**
19+
2. Implement changes, including tests and documentation updates as needed
20+
3. Submit a Pull Request (PR) to **`develop`**
21+
4. Describe clearly:
22+
- Expected behaviour
23+
- Design decisions
24+
- Breaking changes (if any)
25+
5. PRs must be reviewed and approved by Flamapy maintainers
26+
6. Once stable, the `develop` branch will be merged into `main` during a release cycle
27+
28+
---
29+
30+
## Release policy
31+
Flamapy follows **Semantic Versioning** for stable releases.
32+
To ensure reliability and consistency:
33+
34+
- **Up to two major/minor stable releases per year**
35+
- Patch releases will only include critical bug fixes
36+
37+
Release announcements will be shared via the website, GitHub, and mailing channels.
38+
39+
---
40+
41+
## Types of contributions
42+
- Bug fixes 🐛
43+
- New features ✨
44+
- New metamodels or plugins 🔌
45+
- Documentation improvements 📚
46+
- Refactoring and performance improvements ⚙️
47+
48+
For major contributions, please first open an **Issue** describing the motivation, design, and scope, so we can align expectations before implementation.
49+
50+
---
51+
52+
## Plugin ecosystem and licensing
53+
Flamapy supports an open plugin ecosystem. There are two categories of plugins:
54+
55+
### 🔌 Plugins hosted inside the Flamapy GitHub organisation
56+
- Must adopt the **LGPL-3.0** license
57+
- Integrated in the official roadmap and releases
58+
- Reviewed and maintained jointly by the core team
59+
60+
### 🔌 External plugins (hosted outside the organisation)
61+
- May use **any license chosen by the authors**
62+
- Fully compatible with Flamapy architecture
63+
- Can be promoted to the community
64+
65+
If you maintain an external plugin and would like visibility (listing on the webpage, documentation, or community releases), please contact:
66+
67+
📧 **flamapy@us.es**
68+
69+
---
70+
71+
## Licensing model
72+
Flamapy is distributed under the **GNU Lesser General Public License v3.0 (LGPL-3.0)**.
73+
74+
By submitting a Pull Request, you agree to the **implicit contribution agreement**:
75+
- You retain copyright to your contribution
76+
- You grant Flamapy users rights to use, modify and redistribute it under LGPL-3.0
77+
78+
Organisations requiring a **Contributor License Agreement (CLA)** can contact the maintainers. If not, it will be defaulting to implicit contribution agreement.
79+
80+
---
81+
82+
## Code quality guidelines
83+
- Follow existing code style and architecture
84+
- Provide unit tests when applicable
85+
- Explain design decisions in PR description
86+
- Avoid introducing breaking changes without prior discussion
87+
- Document new functionality
88+
89+
---
90+
91+
## Governance
92+
- Core maintainers review and approve contributions
93+
- Major design decisions are taken publicly via Issues and PR discussions
94+
- Roadmap is driven by community needs and research/industry applications
95+
- All new contributors teams are welcome to the core team
96+
97+
---
98+
99+
Thank you again for supporting Flamapy.
100+
Together we build an open, extensible, and high-quality ecosystem for automated feature-model analysis!
101+
102+

‎LICENSE‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

0 commit comments

Comments
 (0)