Skip to content

Commit ad12201

Browse files
Updated Contributing page
1 parent ad1c314 commit ad12201

File tree

7 files changed

+82
-784
lines changed

7 files changed

+82
-784
lines changed

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 76 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 59 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,78 @@
1-
# Contributing to Planka
1+
# Contributing to the Project
22

3-
First off, thanks for taking the time to contribute!
3+
Thank you for taking the time to contribute! Please follow these guidelines to ensure a smooth and productive workflow. 🚀🚀🚀
44

5-
## Code of Conduct
5+
To get started with the project, please refer to the [README.md](https://github.com/suitenumerique/st-projects/blob/main/README.md) for detailed instructions on how to run Projets locally.
66

7-
This project and everyone participating in it is governed by the [Planka Code of Conduct](https://github.com/plankanban/planka/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
7+
Contributors are required to sign off their commits with `git commit --signoff`: this confirms that they have read and accepted the [Developer's Certificate of Origin 1.1](https://developercertificate.org/). For security reasons we also require [signing your commits with your SSH or GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) with `git commit -S`.
88

9-
## How Can I Contribute?
9+
Please also check out our [dev handbook](https://suitenumerique.gitbook.io/handbook) to learn our best practices.
1010

11-
### Reporting Bugs
11+
## Creating an Issue
1212

13-
Feel free to create a bug report as a new issue on GitHub. Before creating, please check if there is already existing one. When creating a bug report, please include as many details as possible.
13+
When creating an issue, please provide the following details:
1414

15-
### Suggesting Enhancements
15+
1. **Title**: A concise and descriptive title for the issue.
16+
2. **Description**: A detailed explanation of the issue, including relevant context or screenshots if applicable.
17+
3. **Steps to Reproduce**: If the issue is a bug, include the steps needed to reproduce the problem.
18+
4. **Expected vs. Actual Behavior**: Describe what you expected to happen and what actually happened.
19+
5. **Labels**: Add appropriate labels to categorize the issue (e.g., bug, feature request, documentation).
1620

17-
Feel free to create an enhancement suggestion as a new issue on GitHub. Before creating, please check if there is already existing one. When creating an enhancement suggestion, please include as many details as possible.
21+
## Commit Message Format
1822

19-
### Pull Requests
23+
All commit messages must adhere to the following format:
2024

21-
Before submitting a pull request please discuss with the core team by creating or commenting in an issue on GitHub – we'd also love to hear from you in the discussions. This way we can ensure that an approach is agreed on before code is written. This will result in a much higher liklihood of your code being accepted.
25+
`<gitmoji>(type) title description`
2226

23-
If you’re looking for ways to get started, here's a list of ways to help us improve Planka:
27+
- <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the list [here](https://gitmoji.dev/).
28+
- **(type)**: Describe the type of change. Common types include `backend`, `frontend`, `CI`, `docker` etc...
29+
- **title**: A short, descriptive title for the change (\*)
30+
- \*\*blank line after the commit title
31+
- **description**: Include additional details on why you made the changes (\*\*).
2432

25-
- [Translation](https://github.com/plankanban/planka/issues/66) into other languages
26-
- Issues with [`good first issue`](https://github.com/plankanban/planka/labels/good%20first%20issue) label
27-
- Performance improvements, both on client and server
28-
- Developer happiness and documentation
29-
- Bugs and other issues listed on GitHub
33+
(\*) ⚠️ **Make sure you add no space between the emoji and the (type) but add a space after the closing parenthesis of the type and use no caps!**
34+
(**) ⚠️ **Commit description message is mandatory and shouldn't be too long\*\*
3035

31-
## Styleguides
36+
### Example Commit Message
3237

33-
### Git Commit Messages
38+
```
39+
✨(frontend) add user authentication logic
3440
35-
Commit messages should follow the [commit message convention](https://conventionalcommits.org), so changelogs could be generated automatically by that.
41+
Implemented login and signup features, and integrated OAuth2 for social login.
42+
```
3643

37-
Additional rules:
44+
## Changelog Update
3845

39-
- Separate subject from body with a blank line
40-
- Limit the subject line to 70 characters
41-
- Capitalize the subject line
42-
- Do not end the subject line with a period
43-
- Use the imperative mood in the subject line
44-
- Use the body to explain what and why vs. how
45-
- Each commit should be a single, stable change
46+
Please add a line to the changelog describing your development. The changelog entry should include a brief summary of the changes, this helps in tracking changes effectively and keeping everyone informed. We usually include the title of the pull request, followed by the pull request ID to finish the log entry. The changelog line should be less than 80 characters in total.
4647

47-
### JavaScript
48+
### Example Changelog Message
4849

49-
All JavaScript code should follow this [JavaScript style guide](https://github.com/airbnb/javascript). The pre-commit hook will help you find linting errors before committing.
50+
```
51+
## [Unreleased]
52+
53+
## Added
54+
55+
- ✨(frontend) add AI to the project #321
56+
```
57+
58+
## Pull Requests
59+
60+
It is nice to add information about the purpose of the pull request to help reviewers understand the context and intent of the changes. If you can, add some pictures or a small video to show the changes.
61+
62+
### Don't forget to:
63+
64+
- signoff your commits
65+
- sign your commits with your key (SSH, GPG etc.)
66+
- check your commits (see warnings above)
67+
68+
The pre-commit hook will help you find linting errors before committing.
69+
70+
## Code Style
71+
72+
Please maintain consistency in code style. Run any linting tools available to make sure the code is clean and follows the project's conventions.
73+
74+
## Asking for Help
75+
76+
If you need any help while contributing, feel free to open a discussion or ask for guidance in the issue tracker. We are more than happy to assist!
77+
78+
Thank you for your contributions! 👍

0 commit comments

Comments
 (0)