Skip to content

Commit 063e3ef

Browse files
Added instruction on how to contribute to the project
1 parent 525cda5 commit 063e3ef

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing to [Python Accelerator Middle Layer (PyAML)]
2+
3+
Thank you for your interest in contributing to [PyAML]! This document outlines how you can help, whether you're fixing bugs, adding features, improving documentation, or participating in community discussions.
4+
5+
## Ways to Contribute
6+
7+
### 1. Reporting Issues
8+
- **Bugs & Feature Requests:** Open an issue on GitHub. Use clear titles and provide as much detail as possible (steps to reproduce, expected/actual behaviour, screenshots, etc.).
9+
- Use an issue template if it is applicable to you. Don't forget to assign an issue to a project and set the status of the issue to TODO.
10+
- **Before Submitting:** Check existing issues to avoid duplicates.
11+
12+
### 2. Working on Tasks
13+
- **Kanban Board:** We use [GitHub Projects](https://github.com/orgs/python-accelerator-middle-layer/projects) to manage tasks. Each column represents a stage in the workflow (e.g., "To Do", "In Progress", "Review", "Done").
14+
- **Claiming a Task:** Comment and assign yourself on the issue or card to let others know you’re working on it. Move the card to "In Progress".
15+
- **Part-time Contributors:** It’s okay to work at your own pace. Just keep the community updated on your progress.
16+
17+
### 3. Submitting Changes
18+
- **Fork & Branch:** Fork the repo and create a branch for your changes.
19+
- **Commits:** Write clear, atomic commit messages. Reference the issue number if applicable.
20+
- **Pull Requests (PRs):**
21+
- Open a PR against the `main` branch.
22+
- Include a description of your changes and reference the relevant issue.
23+
- Ensure your code follows the project’s style and passes all tests.
24+
- A maintainer will review your PR and may suggest changes.
25+
26+
### 4. Documentation
27+
- **Improving Docs:** Fix typos, clarify instructions, or add missing documentation. Submit a PR as you would for code changes.
28+
- **Website:** Our project website is at [python-accelerator-middle-layer.github.io](https://python-accelerator-middle-layer.github.io/).
29+
30+
## Community & Meetingss
31+
32+
### Community Meetings
33+
- **Schedule:** Once every few months.
34+
- **Agenda:** Discuss project direction, upcoming features, and community questions.
35+
- **How to Join:** Write an email to the steering committee of PyAML pyaml-steering-committee-contact@esrf@fr. They will add you to the email list.
36+
- **Mattermost link**: [Mattermost](https://mattermost.hzdr.de/signup_user_complete/?id=cdcea9p8hfr3ic8jdrrydzxxpy&md=link&sbr=su)
37+
38+
### Developer Meetings
39+
- **Schedule:** Bi-weekly, alternating with community meetings.
40+
- **Focus:** Technical discussions, code reviews.
41+
- **How to Join:** Write an email to the steering committee of PyAML pyaml-steering-committee-contact@esrf@fr. They will add you to the email list.
42+
43+
## Getting Help
44+
- **Questions?** Open a discussion on GitHub or ask in our [Mattermost channel](https://mattermost.hzdr.de/signup_user_complete/?id=cdcea9p8hfr3ic8jdrrydzxxpy&md=link&sbr=su).
45+
- **Need Guidance?** Reach out to a maintainer or attend a maintainer or community meeting.
46+
47+
## Recognition
48+
- All contributions are valued and recognised. Significant contributions may be highlighted in release notes or on the project website.
49+
50+
---

0 commit comments

Comments
 (0)