Welcome to the website repository! This README file contains instructions on how to contribute to this project using feature branches for your commits.
Before you start contributing, make sure you have the following prerequisites installed:
If you don't have these installed, please follow the official installation instructions for your operating system.
-
Clone the repository to your local machine:
git clone https://github.com/Wild-Spirits/WS-Portal-Front
-
Change your working directory to the project folder:
cd WS-Portal-Front -
Install dependencies
npm i
-
Start project on your machine
npm start
To contribute to this project, follow these steps:
-
Clone the repository to your local machine:
git clone https://github.com/Wild-Spirits/WS-Portal-Front
-
Change your working directory to the project folder:
cd WS-Portal-Front -
Create a new branch for your feature. Use a descriptive name for the branch that reflects the feature or issue you're working on. For example:
git checkout -b feature/my-new-feature
-
Make your code changes on the feature branch. Ensure your commits are clear, concise, and address a single issue or feature.
-
Stage your changes for commit:
git add . -
Commit your changes with a meaningful message:
git commit -m "Add a concise commit message here" -
Push your feature branch to the remote repository:
git push origin feature/my-new-feature
-
Visit the GitHub repository.
-
Click on the "Pull Requests" tab.
-
Click the "New Pull Request" button.
-
Select the base branch (in our case it is
main) and the feature branch you created in step 3. -
Provide a descriptive title and detailed description of your changes in the pull request.
-
Click the "Create Pull Request" button to submit your changes for review.
Once your pull request is submitted, project maintainers and collaborators will review your changes. They may provide feedback or request modifications. Be prepared to address any comments or suggestions.