Skip to content

Commit 093b323

Browse files
Modify the contributing to our needs
1 parent 490e25a commit 093b323

File tree

1 file changed

+10
-54
lines changed

1 file changed

+10
-54
lines changed

CONTRIBUTING.md

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

43
First off, thanks for taking the time to contribute! ❤️
@@ -11,20 +10,13 @@ All types of contributions are encouraged and valued. See the [Table of Contents
1110
> - Refer this project in your project's readme
1211
> - Mention the project at local meetups and tell your friends/colleagues
1312
14-
<!-- omit in toc -->
1513
## Table of Contents
1614

1715
- [I Have a Question](#i-have-a-question)
18-
- [I Want To Contribute](#i-want-to-contribute)
16+
- [I Want To Contribute](#i-want-to-contribute)
1917
- [Reporting Bugs](#reporting-bugs)
2018
- [Suggesting Enhancements](#suggesting-enhancements)
21-
- [Your First Code Contribution](#your-first-code-contribution)
22-
- [Improving The Documentation](#improving-the-documentation)
23-
- [Styleguides](#styleguides)
24-
- [Commit Messages](#commit-messages)
25-
- [Join The Project Team](#join-the-project-team)
26-
27-
19+
- [Pushing Commits to Pull Requests](#pushing-commits-to-pull-requests)
2820

2921
## I Have a Question
3022

@@ -36,33 +28,17 @@ If you then still feel the need to ask a question and need clarification, we rec
3628

3729
- Open an [Issue](https://github.com/lambdaclass/cairo_native/issues/new).
3830
- Provide as much context as you can about what you're running into.
39-
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
31+
- Provide project and platform versions (Cairo language, Rust compiler, os, arch, etc.), depending on what seems relevant.
4032

4133
We will then take care of the issue as soon as possible.
4234

43-
<!--
44-
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
45-
46-
Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
47-
- IRC
48-
- Slack
49-
- Gitter
50-
- Stack Overflow tag
51-
- Blog
52-
- FAQ
53-
- Roadmap
54-
- E-Mail List
55-
- Forum
56-
-->
57-
5835
## I Want To Contribute
5936

60-
> ### Legal Notice <!-- omit in toc -->
37+
> ### Legal Notice
6138
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
6239
6340
### Reporting Bugs
6441

65-
<!-- omit in toc -->
6642
#### Before Submitting a Bug Report
6743

6844
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
@@ -74,14 +50,13 @@ A good bug report shouldn't leave others needing to chase you up for more inform
7450
- Collect information about the bug:
7551
- Stack trace (Traceback)
7652
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
77-
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
53+
- Version of the Cairo compiler, Cairo Native, Rust, package manager, depending on what seems relevant.
7854
- Possibly your input and the output
7955
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
8056

81-
<!-- omit in toc -->
8257
#### How Do I Submit a Good Bug Report?
8358

84-
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.
59+
<!-- > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>. -->
8560
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
8661

8762
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
@@ -97,55 +72,36 @@ Once it's filed:
9772
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
9873
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
9974

100-
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
101-
102-
10375
### Suggesting Enhancements
10476

10577
This section guides you through submitting an enhancement suggestion for Cairo Native, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
10678

107-
<!-- omit in toc -->
10879
#### Before Submitting an Enhancement
10980

11081
- Make sure that you are using the latest version.
11182
- Read the [documentation](https://lambdaclass.github.io/cairo_native/cairo_native/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
11283
- Perform a [search](https://github.com/lambdaclass/cairo_native/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
11384
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
11485

115-
<!-- omit in toc -->
11686
#### How Do I Submit a Good Enhancement Suggestion?
11787

11888
Enhancement suggestions are tracked as [GitHub issues](https://github.com/lambdaclass/cairo_native/issues).
11989

12090
- Use a **clear and descriptive title** for the issue to identify the suggestion.
12191
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
12292
- **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.
123-
- 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. <!-- this should only be included if the project has a GUI -->
12493
- **Explain why this enhancement would be useful** to most Cairo Native users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
12594

126-
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
127-
128-
### Your First Code Contribution
129-
<!-- TODO
130-
include Setup of env, IDE and typical getting started instructions?
95+
### Pushing Commits to Pull Requests
13196

132-
-->
97+
This repository enforces commit signing on all branches. See [this page](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) for more details on how to sign a commit and how to manage signing keys in Github.
13398

134-
### Improving The Documentation
13599
<!-- TODO
136-
Updating, improving and correcting the documentation
137-
138-
-->
139-
140100
## Styleguides
141101
### Commit Messages
142-
<!-- TODO
143-
102+
### Labels
144103
-->
145104

146-
## Join The Project Team
147-
<!-- TODO -->
148-
149-
<!-- omit in toc -->
150105
## Attribution
106+
151107
This guide is based on the [contributing.md](https://contributing.md/generator)!

0 commit comments

Comments
 (0)