diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ec7d378 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,52 @@ +# Firstspot Code of Conduct + +## Overview + +As contributors and maintainers of the firstspots, we pledge to foster an open and welcoming environment. We value the participation of each member and want everyone to have an enjoyable and fulfilling experience. + +## Code of Conduct + +### 1. Purpose + +A primary goal of this Code of Conduct is to ensure a safe and inclusive environment for all contributors. We encourage respectful and constructive communication, and we will not tolerate harassment or discrimination of any kind. + +### 2. Open and Inclusive + +We welcome contributors of all backgrounds, identities, and experiences. This includes, but is not limited to, members of any race, ethnicity, culture, national origin, color, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion, and mental and physical ability. + +### 3. Expected Behavior + +We expect all contributors to: + +- Be respectful and considerate of others. +- Use inclusive language and avoid offensive comments or content. +- Listen actively and be open to different perspectives and experiences. +- Constructively criticize ideas, not people. +- Show empathy towards fellow contributors. + +### 4. Unacceptable Behavior + +Unacceptable behaviors include, but are not limited to: + +- Harassment or discrimination of any kind. +- Offensive comments or content. +- Intimidation or bullying. +- Inappropriate or unwelcome attention. +- Any form of discrimination. + +### 5. Reporting and Enforcement + +If you witness or experience any behavior that violates this Code of Conduct, please report it by contacting jaysomani2016@gmail.com. All reports will be kept confidential. The project maintainers reserve the right to take appropriate action, including but not limited to warning, temporary ban, or permanent ban from the project. + +### 6. Acknowledgment + +By contributing to this project, you agree to abide by this Code of Conduct. Project maintainers have the right to remove any contributor for violating this code. + +### 7. Scope + +This Code of Conduct applies to all project spaces, including GitHub repositories, communication channels, and events associated with the project. + +## Contact + +For any questions or concerns regarding this Code of Conduct, please contact jaysomani2016@gmail.com. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db719c8..5f3f7d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,172 +1,112 @@ -# Contributing guidelines -Thank you for taking the time to contribute to the project. Please take a moment to read the following guidelines before contributing: +# Contributing to firstspot -## Important point to keep in mind before starting ✅ +First of all thanks for taking time to contribute! -- If anything is missing or if you find something that needs to be enhanced/fixed/modified in the project, please feel free to [create an issue.](https://github.com/singodiyashubham87/ScrapeIt/issues/new/choose) -- Ask to get the issue assigned to you before working on the issue & making a PR. -- Don't create a PR until the issue is not assigned to you. -- Mention the issue number in the PRs and describe all the changes that you have made briefly in the PR(if possible attach a screen recording showing the changes you made). +The following is a set of guidelines for contributing to firstspot. -## How to Contribute? 🤔 +### Table Of Contents +1. [Code of Conduct](#code-of-conduct) +2. [Ways to Contribute](#ways-to-contribute) +3. [How to Contribute](#how-to-contribute) +4. [Submitting Pull Requests](#submitting-pull-requests) -### Step 1: Fork the Repository -Click on the "Fork" button. +## Code of Conduct +This project and everyone participating in it is governed by the [firstspot Code of Conduct](CODE_OF_CONDUCT.md). -By forking the repository, you will have your version of the repository under your GitHub username. +## Ways to Contribute -Once you have forked your repository, go to your profile inside the repository section, and you will find your forked repository. +### Code Contributions -### Step 2: Clone the Forked Repository +- **Fix Bugs:** Identify and fix bugs by submitting pull requests with code changes. +- **Add Features:** Contribute new features or enhancements to improve the project. +- **Optimize Code:** Optimize existing code for better performance or readability. -Once you locate your repository, you must clone it to your local machine. +### Documentation -```sh -git clone https://github.com/YOUR-USERNAME/firstspot.git -``` - -Congratulations! You have successfully cloned the repository to your local machine. You can now make changes, add new features, or fix issues in the codebase. +- **Update Documentation:** Improve and update project documentation, including README files, guides, and inline code comments. -### Step 3: Go to the directory -```sh -cd firstspot -``` +### Issue Reporting -### Step 4: Install all the dependencies -```sh -npm install -``` +- **Bug Reporting:** Report bugs by creating clear and reproducible bug reports. +- **Feature Requests:** Share ideas and request new features by opening well-documented issues. -### Step 5: Start the application -```sh -npm run dev -``` +## How to Contribute -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +### 1. Explore existing [Issues](https://github.com/jaysomani/firstspot/issues) or [create a new issue](https://github.com/jaysomani/firstspot/issues/new/choose). +**Note**: Only start work on the issue after getting assigned by the repository maintainer. -### Step 5: Create a New Branch (important) +### 2. Fork the Repository. +Click the "Fork" button on the GitHub repository to create your own copy of the project. -It's recommended to create a new branch for your changes. This helps keep your modifications separate from the main branch, making it easier to manage and review your contributions. +fork -```sh -git checkout -b +### 3. Clone Your Fork +```bash +git clone https://github.com//firstspot.git ``` -### Step 5: Make Your Changes - -Make the necessary changes or additions to the codebase. -Once you have added changes in your local, its time to push them, for that run this command to bring the modification to the staging area. - -### Step 6: Check your changes - -``` -git status +### 4. Navigate to the newly created firstspot project directory: +```bash +cd firstspot ``` +### 5. Set upstream command +Set the upstream to synchronize your forked repository with the original repository. +```bash +git remote add upstream https://github.com/jaysomani/firstspot ``` -git diff -``` - -git status: Shows the current status of the repository, including changes, untracked files, and branch information. - -git diff: Displays the differences between the working directory and the last commit or between branches. - -### Step 10: Stage your changes -``` -git add . +### 6. Create a new branch +```bash +git checkout -b YourBranchName ``` -This command is used to stage all the changes in the current directory and it's subdirectories for the next commit. It adds all modified and new files to the staging area, allowing you to include them in the next commit. +### 7. Sync your fork or your local repository with the origin repository -**Note:** The . represents the current directory, so git add . includes all files and directories within the current working directory. This means if you are anywhere outside from the directory then the changes would not be staged. -So make sure you are in correct directory. +#### Method 1: +using the Command Line Interface. +```bash +git fetch upstream +git merge upstream/main +``` -### Step 7: Commit Your Changes +#### Method 2: +Using the github Graphical User Interface. +- In your forked repository, click on "Fetch upstream" +- Click "Fetch and merge" -Commit your changes with a meaningful commit message using the following command: +### 8. Make your changes to the source code. +### 9. Stage your changes and commit +⚠️ Make sure not to run the commands git add . or git add *. Instead, stage your changes for each file/folder ```bash - git commit -m "Enter Your message related to what work you did" +git add ``` -(make sure to add a decent commit message to avoid confusion and get your PR merged) - -Once you have committed your changes, it's time to push them to your forked repository on GitHub. - -### Step 8: Push Your Changes - -Use the following command to push your changes: ```bash -git push -u origin +git commit -m "" ``` -Replace with the name of the branch you created earlier. - -### Step 9: Make a Pull Request - -After pushing your changes, open your forked repository on GitHub in your web browser. - -Click on `compare and pull request` - -Provide a clear and informative title and description for your pull request. Explain the changes you have made and why they should be incorporated into the original repository. - -Review your pull request to ensure everything is correct, and then click on the "Create pull request" button to submit it. - -### Congratulations! 🎉 - -Your pull request will now be visible to the maintainers of the original repository. They will review your changes, provide feedback if necessary, and decide whether to merge them into the main branch. - -Congratulations! You have successfully created a pull request to contribute your changes to the repository. Remember to monitor the pull request for any updates or feedback from the maintainers. - - -### Commit Message Guidelines using Commitlint - -We follow a standardized commit message format using Commitlint to ensure consistency and clarity in our commit history. Each commit message should adhere to the following guidelines: - -1. **Type**: The commit type must be one of the following: - - - `feat`: A new feature or enhancement. - - `fix`: A bug fix. - - `docs`: Documentation changes. - - `style`: Code style changes (e.g., formatting, semicolons). - - `refactor`: Code refactorings with no feature changes or bug fixes. - - `test`: Adding or improving tests. - - `chore`: General maintenance tasks, build changes, etc. - -2. **Scope** (Optional): The scope provides context for the commit, indicating the specific part of the project being affected. Use a short description in lowercase (e.g., `navbar`, `README`). - -3. **Description**: A brief and meaningful description of the changes made. Start with a capital letter and use the imperative mood (e.g., "Add new feature" instead of "Added new feature"). - -4. **Issue reference** (Optional): Include the issue number associated with the commit (e.g., `#123`). - -### Examples: - -#### Valid Commit Messages: - -- `feat: Add user authentication feature` -- `docs: Update installation instructions` -- `style: Format code according to project guidelines` -- `refactor(navbar): Improve responsiveness` -- `test: Add unit tests for API endpoints` -- `chore: Update dependencies to latest versions` -- `fix: Handle edge case in data processing (#456)` +### 10. Push your local commits to the remote repository +```bash +git push origin yourBranchName +``` -#### Invalid Commit Messages: +### 11. In your forked repository create a Pull Request(PR) +See the Pull Requests guidelines [here](#submitting-pull-requests). -- `Added new stuff` -- `Fixed a bug` -- `Updated code` -- `auth feature update` -- `chore: fixed some stuff` +**Note:** After making PR wait for the PR to be reviewed and make changes if required. +### 12. Congratulations!🎉 You've made your first contribution to firstspot! 🙌🏼 -By following these guidelines, we can maintain a clean commit history that is easy to understand and helps us effectively track changes. If you have any questions or need further assistance, feel free to ask! Happy contributing! +## Submitting Pull Requests +When submitting a pull request, please ensure the following: -

Don't forget to give a ⭐ to this repo !! -

+- You have added necessary tests for your changes. +- The pull request description clearly explains the changes made and the reasoning behind them. +- Screenshot of the changes. diff --git a/README.md b/README.md index 1ef0bf4..7d46240 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,8 @@ If you're new to open source, these resources will guide you through the basics ## Contributing 👨‍💻 +See the [CONTRIBUTING.md](CONTRIBUTING.md) file for contributing to firstspot. + ### How to Contribute 1. Explore existing [Issues](https://github.com/jaysomani/firstspot/issues) or [create a new issue](https://github.com/jaysomani/firstspot/issues/new/choose). @@ -111,3 +113,4 @@ If you're new to open source, these resources will guide you through the basics 10. Create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)! 11. **Congratulations!** You've made your first contribution to [**firstspot**](https://github.com/jaysomani/firstspot/graphs/contributors)! 🙌🏼 +