Skip to content

Commit 248f5a4

Browse files
committed
Update CONTRIBUTING.md
1 parent 0e4260b commit 248f5a4

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<!-- omit in toc -->
21
# Contributing to Lambda
32

43
First off, thanks for taking the time to contribute! ❤️
@@ -9,7 +8,6 @@ All types of contributions are encouraged and valued. See the [Table of Contents
98
> - Star the project
109
> - Donate to the project
1110
12-
<!-- omit in toc -->
1311
## Table of Contents
1412

1513
- [I Have a Question](#i-have-a-question)
@@ -18,8 +16,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
1816
- [Suggesting Enhancements](#suggesting-enhancements)
1917
- [Your First Code Contribution](#your-first-code-contribution)
2018
- [Improving The Documentation](#improving-the-documentation)
21-
- [Styleguides](#styleguides)
22-
- [Commit Messages](#commit-messages)
19+
- [Naming Convention](#naming-convention)
2320
- [Join The Project Team](#join-the-project-team)
2421

2522

@@ -98,7 +95,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/lambda
9895
- Use a **clear and descriptive title** for the issue to identify the suggestion.
9996
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
10097
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
101-
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
98+
- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux.
10299
- **Explain why this enhancement would be useful** to most Lambda users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
103100

104101
### Your First Code Contribution
@@ -122,6 +119,11 @@ After you have everything you can do the following:
122119
### Improving The Documentation
123120
If you believe that some documentation can be improved or added, please discuss with us on our [Discord](https://discord.gg/QjfBxJzE5x)
124121

122+
### Naming Convention
123+
We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for the Lambda project.
124+
125+
Feel free to propose additional compatible naming conventions.
126+
125127
## Join The Project Team
126128
Most communication happens on our [Discord](https://discord.gg/QjfBxJzE5x). You can join the project team by contributing to the project. The project team is responsible for reviewing and merging pull requests, and they will help you at every step of the way.
127129

0 commit comments

Comments
 (0)