-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into enhance/privacyPolicy
Signed-off-by: Sawan kushwah <[email protected]>
- Loading branch information
Showing
27 changed files
with
1,366 additions
and
543 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,53 +1,220 @@ | ||
| # Contributing to Bitbox | ||
| # Contributing to Bitbox 🎯 | ||
|
|
||
| Thank you for your interest in contributing to **Bitbox**! We welcome contributions from everyone, whether you're a beginner or an experienced developer. | ||
|
|
||
| ## How to Contribute | ||
| <br> | ||
|
|
||
| ### 1. Fork the Repository | ||
| Start by forking the repository to your GitHub account. | ||
| # Code of Conduct 📃 | ||
|
|
||
| ### 2. Clone Your Fork | ||
| Clone the repository to your local machine using: | ||
| Please read and follow our [Code of Conduct](https://github.com/Bitbox-Connect/Bitbox/blob/main/Code_of_Conduct.md) | ||
|
|
||
| <br> | ||
|
|
||
| # <h1 align="center">Star our Repository ⭐</h1> | ||
|
|
||
| ### <div align = "center" style = "display:flex; justify-content:space-evenly; gap:100px;" > [](https://github.com/Bitbox-Connect/Bitbox/stargazers) [](https://github.com/Bitbox-Connect/Bitbox/network/members) [](https://github.com/Bitbox-Connect/Bitbox/issues) [](https://github.com/Bitbox-Connect/Bitbox/pulls) [](https://github.com/Bitbox-Connect/Bitbox/pulls?q=is%3Apr+is%3Aclosed)</div> | ||
|
|
||
| <br> | ||
|
|
||
| # Need Help With The Basics? 🤔 | ||
|
|
||
| If you're new to Git and GitHub, no worries! Here are some useful resources: | ||
|
|
||
| - [Forking a Repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) | ||
| - [Cloning a Repository](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) | ||
| - [How to Create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) | ||
| - [Getting Started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) | ||
| - [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources) | ||
|
|
||
| <br> | ||
|
|
||
| # Project Structure 📂 | ||
|
|
||
| ```bash | ||
| $ git clone https://github.com/<your-username>/Bitbox.git | ||
| BITBOX/ | ||
| ├── .github/ # GitHub-related configurations such as workflows, issue templates, etc | ||
| │ | ||
| ├── assets/ # All the assets included in the project | ||
| │ | ||
| ├── client/ # Client side files | ||
| │ | ||
| ├── server/ # Some file components related to the server side | ||
| │ | ||
| ├── .env.txt | ||
| │ | ||
| ├── CONTRIBUTING.md # Instructions for the contributors | ||
| │ | ||
| ├── Code_of_Conduct # Some rules for the contributors | ||
| │ | ||
| ├── LICENSE # A permission to do something | ||
| │ | ||
| ├── README.md # Some instructions related to the contributions | ||
| │ | ||
| ├── package-lock.json | ||
| ``` | ||
|
|
||
| ### 3. Create a New Branch | ||
| Create a branch for your contribution: | ||
| <br> | ||
|
|
||
| # First Pull Request ✨ | ||
|
|
||
| 1. **Star this repository** | ||
| Click on the top right corner marked as **Stars** at last. | ||
|
|
||
| 2. **Fork this repository** | ||
| Click on the top right corner marked as **Fork** at second last. | ||
|
|
||
| 3. **Clone the forked repository** | ||
|
|
||
| ```bash | ||
| $ git checkout -b <branch-name> | ||
| git clone https://github.com/<your-github-username>/Bitbox.git | ||
| ``` | ||
|
|
||
| 4. **Navigate to the project directory** | ||
|
|
||
| ### 4. Make Your Changes | ||
| Add new Features, improve documentation, or fix any issues. Be sure to: | ||
| - Document your code with clear comments | ||
| - Ensure that your solution is correct and efficient | ||
| ```bash | ||
| cd Bitbox | ||
| ``` | ||
|
|
||
| ### 5. Commit Your Changes | ||
| Commit your changes with a descriptive commit message: | ||
| 5. **Create a new branch** | ||
|
|
||
| ```bash | ||
| $ git commit -m "Added [Feature-name]" | ||
| git checkout -b <your_branch_name> | ||
| ``` | ||
|
|
||
| ### 6. Push to Your Fork | ||
| Push your changes to your forked repository: | ||
| 6. **To make changes** | ||
|
|
||
| ```bash | ||
| $ git push origin <branch-name> | ||
| git add . | ||
| ``` | ||
|
|
||
| ### 7. Create a Pull Request | ||
| Go to the original repository and create a Pull Request (PR). Make sure to describe what you’ve changed and why. | ||
| 7. **Now to commit** | ||
|
|
||
| ```bash | ||
| git commit -m "add comment according to your changes or addition of features inside this" | ||
| ``` | ||
|
|
||
| 8. **Push your local commits to the remote repository** | ||
|
|
||
| ```bash | ||
| git push -u origin <your_branch_name> | ||
| ``` | ||
|
|
||
| 9. **Create a Pull Request** | ||
|
|
||
| 10. **Congratulations! 🎉 you've made your contribution** | ||
|
|
||
| <br> | ||
|
|
||
| # Alternatively, contribute using GitHub Desktop 🖥️ | ||
|
|
||
| 1. **Open GitHub Desktop:** | ||
| Launch GitHub Desktop and log in to your GitHub account if you haven't already. | ||
|
|
||
| 2. **Clone the Repository:** | ||
| - If you haven't cloned the project repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository." | ||
| - Choose the project repository from the list of repositories on GitHub and clone it to your local machine. | ||
|
|
||
| 3.**Switch to the Correct Branch:** | ||
| - Ensure you are on the branch that you want to submit a pull request for. | ||
| - If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch. | ||
|
|
||
| 4. **Make Changes:** | ||
| - Make your changes to the code or files in the repository using your preferred code editor. | ||
|
|
||
| 5. **Commit Changes:** | ||
| - In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit. | ||
| - Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to <branch-name>" button to commit your changes to the local branch. | ||
|
|
||
| ## Contribution Guidelines | ||
| 6. **Push Changes to GitHub:** | ||
| - After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub. | ||
|
|
||
| 7. **Create a Pull Request:** | ||
| - Go to the GitHub website and navigate to your fork of the project repository. | ||
| - You should see a button to "Compare & pull request" between your fork and the original repository. Click on it. | ||
|
|
||
| 8. **Review and Submit:** | ||
| - On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request. | ||
| - Once you're satisfied, click the "Create pull request" button to submit your pull request. | ||
|
|
||
| 9. **Wait for Review:** | ||
| Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the project repository. | ||
|
|
||
| <br> | ||
|
|
||
| # For Help And Support 💬 | ||
|
|
||
| - Admin Github Profile:- [Anuj Verma](https://github.com/Anuj3553) | ||
| - Contact :- [Email]([email protected]) | ||
|
|
||
| <br> | ||
|
|
||
| # Good Coding Practices 🧑💻 | ||
|
|
||
| 1. **Follow the Project's Code Style** | ||
|
|
||
| - Maintain consistency with the existing code style (indentation, spacing, comments). | ||
| - Use meaningful and descriptive names for variables, functions, and classes. | ||
| - Keep functions short and focused on a single task. | ||
| - Avoid hardcoding values; instead, use constants or configuration files when possible. | ||
|
|
||
| 2. **Write Clear and Concise Comments** | ||
|
|
||
| - Use comments to explain why you did something, not just what you did. | ||
| - Avoid unnecessary comments that state the obvious. | ||
| - Document complex logic and functions with brief explanations to help others understand your thought -process. | ||
|
|
||
| 3. **Keep Code DRY (Don't Repeat Yourself)** | ||
|
|
||
| - Avoid duplicating code. Reuse functions, methods, and components whenever possible. | ||
| - If you find yourself copying and pasting code, consider creating a new function or component. | ||
|
|
||
| 4. **Write Tests** | ||
|
|
||
| - Write unit tests for your functions and components. | ||
| - Ensure your tests cover both expected outcomes and edge cases. | ||
| - Run tests locally before making a pull request to make sure your changes don’t introduce new bugs. | ||
|
|
||
| 5. **Code Reviews and Feedback** | ||
|
|
||
| - Be open to receiving constructive feedback from other contributors. | ||
| - Conduct code reviews for others and provide meaningful suggestions to improve the code. | ||
| - Always refactor your code based on feedback to meet the project's standards. | ||
|
|
||
| <br> | ||
|
|
||
| # Pull Request Process 🚀 | ||
|
|
||
| When submitting a pull request, please adhere to the following: | ||
|
|
||
| 1. **Self-review your code** before submission. 😀 | ||
| 2. Include a detailed description of the functionality you’ve added or modified. | ||
| 3. Comment your code, especially in complex sections, to aid understanding. | ||
| 4. Add relevant screenshots to assist in the review process. | ||
| 5. Submit your PR using the provided template and hang tight; we'll review it as soon as possible! 🚀 | ||
|
|
||
| <br> | ||
|
|
||
| # Issue Report Process 📌 | ||
|
|
||
| To report an issue, follow these steps: | ||
|
|
||
| 1. Navigate to the project's issues section :- [Issues](https://github.com/Bitbox-Connect/Bitbox/issues/new/choose) | ||
| 2. Please kindly choose the appropriate template according to your issue. | ||
| 3. Provide a clear and concise description of the issue. | ||
| 4. Wait until someone looks into your report. | ||
| 5. Begin working on the issue only after you have been assigned to it. 🚀 | ||
|
|
||
| <br> | ||
|
|
||
| # Contribution Guidelines 📝 | ||
| - Keep your code clean and well-documented. | ||
| - Stick to best practices for the programming language you are contributing in. | ||
| - Respect the folder structure and organization of the repository. | ||
|
|
||
| --- | ||
| <br> | ||
|
|
||
| # Thank you for contributing 💗 | ||
|
|
||
| We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀 | ||
|
|
||
| Thank you for your contributions! Together, we can build something amazing. ✨ | ||
| ## |
Oops, something went wrong.