Debian Codegraph @

.cargo/vendor/pastey/CONTRIBUTING.md

raw
1 # Contributing to Pastey
2
3 Thank you for your interest in contributing to Pastey! Here are some guidelines to help you get started.
4
5 ## Project Goals
6
7 One of our main goals is to ensure that Pastey is a drop-in replacement for the paste crate. It should
8 not change the behavior or names of existing modifiers. For new behavior, please create a new modifier.
9
10 For this we have a special test crate named [paste-compat](./paste-compat/), it is always appreciated
11 to add more test cases here that works on paste crate.
12
13 ## Testing
14
15 Run `./test.sh` for testing your code
16
17 ## How to Contribute
18
19 1. **Fork the repository**: Click the "Fork" button at the top right of the repository page.
20 2. **Clone your fork**:
21
22 ```sh
23 git clone https://github.com/your-username/pastey.git
24 cd pastey
25 ```
26
27 3. **Create a new branch**:
28
29 ```sh
30 git checkout -b my-feature-branch
31 ```
32
33 4. **Make your changes**: Implement your feature or bug fix.
34 5. **Commit your changes**:
35
36 ```sh
37 git commit -am 'Add new feature'
38 ```
39
40 6. **Push to your branch**:
41
42 ```sh
43 git push origin my-feature-branch
44 ```
45
46 7. **Create a Pull Request**: Go to the repository on GitHub and click "New Pull Request".
47
48 ## Code Style
49
50 Please follow the existing code style and conventions. Ensure your code is well-documented and tested.
51
52 ## Reporting Issues
53
54 If you find a bug or have a feature request, please create an issue on GitHub. Provide as much detail as
55 possible to help us understand and address the issue.
56
57 ## License
58
59 By contributing to Pastey, you agree that your contributions will be licensed under the same license as the project: either the Apache License, Version 2.0 or the MIT license.
60
61 Thank you for your contributions!