|
1 | | -# Contributing to QNFO Projects |
| 1 | +# ⚠️ DEPRECATED -- Migrated to GitHub-Native Features |
2 | 2 |
|
3 | | -**QNFO's ultimate aim is to advance scientific understanding and catalyze positive, |
4 | | -systemic global change for the collective benefit of all.** |
| 3 | +**This file is superseded by GitHub-native project management tools.** |
5 | 4 |
|
6 | | -Thank you for your interest in contributing. This document outlines the standards |
7 | | -and process for contributing to any QNFO repository. All contributions are governed |
8 | | -by the [QNFO Content License Agreement](LICENSE) and [Code of Conduct](CODE_OF_CONDUCT.md). |
| 5 | +All QNFO repos now use GitHub-native features for project management: |
| 6 | +- **Wiki** for persistent documentation (charter, learnings, DoD, state) |
| 7 | +- **Issues** for backlog, risks, and tasks with priority labels |
| 8 | +- **Projects** for sprint/kanban tracking |
| 9 | +- **Discussions** for decisions and announcements |
| 10 | +- **Releases** for versioned changelogs |
9 | 11 |
|
| 12 | +See the [QWAV Wiki](https://github.com/QNFO/QWAV/wiki) for the reference implementation. |
| 13 | +See the [QNFO org Projects](https://github.com/orgs/QNFO/projects) for cross-project tracking. |
10 | 14 |
|
11 | | -## Before You Contribute |
| 15 | +**This file will not be updated. Do not edit.** |
12 | 16 |
|
13 | | -1. **Read the LICENSE.** All contributions are governed by the QNFO Content License |
14 | | - Agreement v1.1. By submitting a contribution, you agree that your contribution |
15 | | - will be licensed under those same terms, and that you have the right to do so. |
16 | | - |
17 | | -2. **Read the Code of Conduct.** All QNFO spaces are governed by the |
18 | | - [Code of Conduct](CODE_OF_CONDUCT.md). Harassment, discrimination, bad-faith |
19 | | - argumentation, and unethical uses have no place here. |
20 | | - |
21 | | -3. **Check existing issues and discussions.** Before opening a new issue, search |
22 | | - existing issues and discussions to see if your topic is already being addressed. |
23 | | - |
24 | | - |
25 | | -## How to Contribute |
26 | | - |
27 | | -### Bug Reports |
28 | | - |
29 | | -- Use the issue tracker |
30 | | -- Describe the bug clearly: what happened, what you expected, steps to reproduce |
31 | | -- Include environment information (OS, browser, Python version, etc.) |
32 | | -- Attach relevant logs, screenshots, or error messages |
33 | | - |
34 | | -### Feature Requests and Enhancements |
35 | | - |
36 | | -- Open an issue with the "enhancement" label |
37 | | -- Describe the proposed change and its rationale |
38 | | -- Explain how it advances the project's goals |
39 | | -- Be open to discussion and iteration |
40 | | - |
41 | | -### Code and Documentation Contributions |
42 | | - |
43 | | -1. **Fork the repository** and create a feature branch |
44 | | -2. **Make your changes** following the project's conventions |
45 | | -3. **Write or update tests** if applicable |
46 | | -4. **Update documentation** to reflect changes |
47 | | -5. **Submit a pull request** with a clear description of changes |
48 | | -6. **Link to relevant issues** in the PR description |
49 | | - |
50 | | -### Publication and Research Contributions |
51 | | - |
52 | | -- Research proposals, paper drafts, and theoretical contributions are welcome |
53 | | -- Submit via issues or discussions with the "research" label |
54 | | -- Clearly distinguish established results from speculation |
55 | | -- Cite all sources and prior art |
56 | | - |
57 | | - |
58 | | -## Standards |
59 | | - |
60 | | -### Code Quality |
61 | | -- Write clear, self-documenting code |
62 | | -- Include comments for non-obvious logic |
63 | | -- Follow existing code style conventions in the repository |
64 | | -- Test your changes before submitting |
65 | | - |
66 | | -### Documentation |
67 | | -- Use clear, accessible language |
68 | | -- Define specialized terms |
69 | | -- Keep documentation current with code changes |
70 | | -- Translate or summarize complex material where feasible |
71 | | - |
72 | | -### Attribution |
73 | | -- Give proper credit to prior work |
74 | | -- Cite sources, datasets, and inspirations |
75 | | -- The LICENSE requires attribution for content use -- this applies to |
76 | | - contributions as well |
77 | | - |
78 | | - |
79 | | -## Licensing of Contributions |
80 | | - |
81 | | -By submitting a contribution to any QNFO repository, you affirm that: |
82 | | - |
83 | | -1. You are the original author of the contribution OR have the right to submit |
84 | | - it under the QNFO Content License Agreement |
85 | | -2. Your contribution is licensed under the QNFO Content License Agreement v1.1 |
86 | | - (the same terms as the repository) |
87 | | -3. You understand that contributions are made for non-commercial, public-good |
88 | | - purposes |
89 | | -4. You have disclosed any third-party material included in your contribution |
90 | | - and its applicable license |
91 | | - |
92 | | - |
93 | | -## Questions? |
94 | | - |
95 | | -For questions about contributing, contact the Principal Investigator at |
96 | | -rowan.quni@qnfo.org (backup: rowan.quni@outlook.com). |
97 | | - |
98 | | - |
99 | | ---- |
100 | | - |
101 | | -*QNFO -- advancing scientific understanding for the collective benefit of all. |
102 | | -Everything open. Everything accountable. Everything for the good.* |
| 17 | +*Migrated 2026-05-24 during org-wide PM file deprecation.* |
0 commit comments