-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
61544cf
commit 9bfcf73
Showing
1 changed file
with
14 additions
and
96 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 |
|---|---|---|
| @@ -1,104 +1,22 @@ | ||
| # ReactCreations | ||
| # Welcome to React three fiber Minecraft | ||
|
|
||
| Join the [discord server](https://discord.gg/JdFsJPrayj) for more discussion: | ||
| This project is just me trying to mimic Minecraft in React. | ||
|
|
||
| Welcome to my open-source project! We're excited to have you on board. Hacktoberfest is a month-long celebration of open source software, and we encourage everyone to participate. Whether you're a seasoned developer or just starting out, there are plenty of ways to get involved. | ||
| ## How to play? | ||
|
|
||
| Currently it has 5 types of blocks: Grass, Wood, Log, Glass and Dirt. | ||
| You switch blocks with numbers 1-5 on your keyboard. | ||
| You navigate the world with the mouse and WASD. | ||
| You can click to add blocks and Alt+Click to remove blocks. | ||
| You world is stored in your browsers local storage. | ||
|
|
||
| ## Repository Motive | ||
|  | ||
|
|
||
| Our project aims to contribute more and build more opensource projects using React Js. We believe in the power of collaboration and open-source contributions. By joining us, you'll be part of a vibrant community working towards a common goal. Your contributions will not only enhance the project but also help you improve your skills and connect with like-minded individuals. | ||
| ## Setup | ||
|
|
||
| ## How to get started with Open Source | ||
| In the project directory, you can run: | ||
|
|
||
| Here's a quick run down on how to get started with open source, first of all let's know some basic terminologies: | ||
| ### `npm install && npm start` | ||
|
|
||
| - Git: is a versioning system that let's you store your code and code history on your local computer preventing loses and allowing sharing of that code | ||
| - Github: is a server that let's you store the history in a database | ||
| - Open Source: A project is said to be open sourced if you can see the code on GitHub | ||
| - Fork: This is a copy that you make of a project on GitHub, it gets added to your repositories | ||
| - Repository: A project on GitHub is called a repository | ||
| - Pull Request: This is a fix for an issue proposed to be done in a project, this consists of you editing a file in the project. | ||
| - Issue: An issue is a change that should be done in a project, can be a bug, a new feature or a suggestion to a project | ||
| - Branch: A branch is a new workspace derived from the default workspace(main or master), it allows you to work on something without affecting the original code. | ||
| - Star: When you star a repositiory, it gets saved at your profile and you can easily re-visit it later. | ||
|
|
||
| Now you know some basic terms, let's get into how to get started with some resources to let you understand open source better: | ||
|
|
||
| - [Crash Course to Git and Github](https://www.youtube.com/watch?v=apGV9Kg7ics) - Video | ||
| - [A complete Guide to Open Source](https://www.youtube.com/watch?v=yzeVMecydCE) - Video | ||
| - [Guide to Open Source](https://www.freecodecamp.org/news/how-to-contribute-to-open-source-projects-beginners-guide/) - Article | ||
|
|
||
| ## Contributing | ||
|
|
||
| **I heartily welcome any and all contributions that match our engineering standards! :raised_hands:** | ||
|
|
||
| That being said, this codebase isn't your typical open source project because it's not a library or package with a limited scope—it's our entire product. | ||
|
|
||
| * Contributions make the open source community such an amazing place to learn, inspire, and create. | ||
| * Any contributions you make are greatly appreciated. | ||
| * Check out our contribution guidelines for more information. | ||
|
|
||
| ## Rules | ||
|
|
||
| - **No `console.log`s in any file**: We use the `debug` module across the codebase to log debugging information in development only. Never commit a file that contains a `console.log` as CI will fail your build. The only exceptions are errors, which you can log, but you have to use `console.error` to be explicit about it | ||
| - **Code reviews**: All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. | ||
|
|
||
|
|
||
| ## Don't forget to leave a star✨ | ||
| # HAPPY CONTRIBUTING!! | ||
|
|
||
| ### 1. Fork the Repository | ||
|
|
||
| Start by forking our repository to your GitHub account. This will create a copy of the project that you can freely experiment with. | ||
|
|
||
| ### 2. Clone the Repository | ||
|
|
||
| Clone the forked repository to your local machine using the following command: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/Kritika30032002/ReactCreations.git | ||
| ``` | ||
|
|
||
| ### 3. Make Changes | ||
|
|
||
| Add your project in the separate folder. Whether it's adding a new project or improving documentation, your contribution is valuable. | ||
|
|
||
| ### 4. Add Proper Readme | ||
|
|
||
| Readme should describe the proper local setup steps in sequence. | ||
|
|
||
| ### 5. Add it to staging area | ||
| ``` | ||
| git add <path to the file you worked on> | ||
| ``` | ||
|
|
||
| ### 6. Commit Changes | ||
|
|
||
| Commit your changes with a clear and concise commit message explaining the purpose of the changes. | ||
|
|
||
| ```bash | ||
| git commit -m "Add your commit message here" | ||
| ``` | ||
|
|
||
| ### 7. Push Changes | ||
|
|
||
| Push your changes to your forked repository on GitHub. | ||
|
|
||
| ```bash | ||
| git push origin main | ||
| ``` | ||
|
|
||
| ### 8. Create a Pull Request | ||
|
|
||
| Go to the original repository on GitHub and click on the "New Pull Request" button. Compare your branch with the main repository's branch. Provide a detailed description of your changes in the pull request, and submit it for review. | ||
|
|
||
| ### 9. Wait for Review and Merge | ||
|
|
||
| Once you've submitted a pull request, I will review your changes. Be patient during this process, and be ready to address any feedback or questions. Once your changes are approved, they will be merged into the main project. | ||
|
|
||
|
|
||
| ## Thanks to all Contributors 💪 | ||
|
|
||
| Thanks a lot for spending your time. Thanks a lot! Keep rocking 🍻 | ||
| Also Give it a Star 🌟, If you loved contributing to the project. | ||
| Runs the app in the development mode.<br /> | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |