diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..a0ce404 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,82 @@ +

šŸ¤ Contribution šŸ¤

+ +I know you are eager to contribute, but first, go through the following documents: + +1. [Installation](https://github.com/prrockzed/chessed/blob/main/INSTALL.md) +2. [Code of Conduct](https://github.com/prrockzed/chessed/blob/main/.github/CODE_OF_CONDUCT.md) ā€” _Required only for first-time contributors. Regular contributors may skip this._ +3. [Release v1.0.0](https://github.com/prrockzed/chessed/releases/tag/v1.0.0) + +
+Whether you want to fix bugs, improve the ui or add new features! +
+
+Iā€™m eager to collaborate with anyone passionate about improving chessed. +
+If you have ideas or suggestions, feel free to open an issue and submit a pull request. +
+ +### How to Contribute: + +1. **Create an Issue** + + Before starting any contribution, please create an issue using one of the [Issue Templates](https://github.com/prrockzed/chessed/issues/new/choose). Clearly explain the issue or feature you want to work on. We will review it and decide if it fits the project needs. Once approved, the issue will be assigned to you, and you can start working on it. + +2. **Fork the Repository** + + Fork the repository to your own GitHub account to start working on your contribution. + +3. **Clone the Repository** + + Clone the forked repo to your local machine to start coding. The following command will clone the repository to your current folder. + + ```sh + # Replace <...> with your github username and repository name + git clone https://github.com//.git + ``` + +4. **Create a New Branch** + + Create a branch for your feature or bug fix. + + ```sh + # replace feature-name with the feature or issue name you're working on + git checkout -b feature-name + ``` + +5. **Make your changes and commit** + + After implementing your changes, commit them with a meaningful message that describes your work. + + ```sh + # stage your changes + git add . + ``` + + ```sh + # write a meaningful commit message concluding your feature + git commit -m "Added some feature" + ``` + +6. **Push the changes** + + Push your branch to your forked repository. + + ```sh + git push origin feature-name + ``` + +7. **Open a pull request** + + Once your changes are pushed, open a Pull Request (PR) to the main repository. Make sure to link the issue you've been assigned in the PR description. +
+ + +## Note: + +If you have any security issues, check out the [Security Policy](https://github.com/prrockzed/chessed/blob/main/.github/SECURITY.md) +
+ +Feel free to reach out if you have any questions or suggestions! You can use the [Discussions forum](https://github.com/prrockzed/chessed/discussions) to ask questions, propose ideas, or start a conversation. +
+
+Let's make this project better together. diff --git a/.github/LICENSE b/LICENSE similarity index 100% rename from .github/LICENSE rename to LICENSE