-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add CONTRIBUTING.md, LICENSE.md, and SECURITY.md files
- Loading branch information
1 parent
47802a9
commit 4b057f6
Showing
4 changed files
with
27 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
## Contributing | ||
|
||
Contributions to this project are very welcome and greatly appreciated. Whether you're fixing bugs, adding new features, improving performance, or even correcting typos, your help is valuable. | ||
|
||
Here are some steps to contribute to this project: | ||
|
||
1. **Fork the Repository:** Start by forking the repository to your own GitHub account. | ||
|
||
2. **Clone the Repository:** Clone the forked repository to your local machine. | ||
|
||
3. **Create a New Branch:** Always create a new branch for your changes. This keeps the commit history clean and makes it easier to separate and manage different features or fixes. | ||
|
||
4. **Make Your Changes:** Make your changes in the new branch. Please follow the existing coding style and conventions. | ||
|
||
5. **Test Your Changes:** Ensure that your changes do not break any existing functionality. Add new tests if necessary. | ||
|
||
6. **Commit Your Changes:** Commit your changes with a clear and descriptive commit message. | ||
|
||
7. **Push Your Changes:** Push your changes to your forked repository on GitHub. | ||
|
||
8. **Submit a Pull Request:** Submit a pull request from your forked repository to the original repository. Please provide a clear and detailed description of your changes. | ||
|
||
Thank you for your interest in contributing to this project! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Security Policy | ||
|
||
To report a security vulnerability, please contact me [here](https://mcabrera.dev). I will coordinate the fix and disclosure. |