Skip to content

Commit

Permalink
Add CONTRIBUTING.md, LICENSE.md, and SECURITY.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
mcabreradev committed Mar 9, 2024
1 parent 47802a9 commit 4b057f6
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 25 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
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!
2 changes: 1 addition & 1 deletion LICENSE → LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Miguelángel Cabrera
Copyright (c) 2014 Miguelángel Cabrera

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
24 changes: 0 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -702,30 +702,6 @@ The philosophy behind this project is to provide a robust, flexible, and efficie

This project is maintained by [Miguelangel Cabrera](https://mcabrera.dev), a passionate software developer with a deep interest in TypeScript and functional programming. Miguelangel has years of experience in software development and a strong commitment to code quality, performance, and maintainability.

## 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!

## Copyright

Copyright (c) 2024. All rights reserved. This project is licensed under the MIT license. This means you are free to use, modify, and distribute the code, as long as you include the original copyright notice and disclaimers. Please see the LICENSE file in the project root for the full license text.
3 changes: 3 additions & 0 deletions SECURITY.md
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.

0 comments on commit 4b057f6

Please sign in to comment.