Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Added to README and created CONTRIBUTING #50

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing to the Bytes Of Love website

Thank you for considering contributing to the Bytes of Love website! Here are some guidelines to help you get started.

## How to Contribute

If you want to find a good place to start, you can check out our current [issues](https://github.com/ufosc/BytesOfLoveWebsite/issues). Once you know how you'd like to contribute, you can follow the following steps.

1. **Fork the repository**: Click the "Fork" button at the top right of the repo.
2. **Clone your fork**:
```bash
git clone https://github.com/your-username/project-name.git
3. **Create a new branch**:
```bash
git checkout -b feature/your-feature-name
4. **Make changes and commit them**:
```bash
git commit -m "Add some feature"
5. **Push your branch**:
```bash
git push origin feature/your-feature-name
6. **Create a pull request: Go to the original repository and click "New Pull Request".**:

## Coding Guidelines
- Match the exisitng code style (indentation, variable naming, whitespace)
- Write clear and descriptive commit messages (for help with this, [see here](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/))
- Include comments in your code for clarity
- Ensure your changes are tested, ideally in multiple browsers and platforms

## Questions or Issues?
If you have any questions or run into any issues, feel free to reach out or open an issue in the repository.

Thanks for contributing!



8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

Welcome to the website for **Bytes of Love**!

This website allows players to learn about what Bytes of Love is and get a download of the current game for FREE!
Bytes of Love is an engaging dating simulator with immersive romantic storylines and and character interactions.

This website allows players to learn more about what Bytes of Love is and get a download of the current game for FREE!

## Website Link

Expand Down Expand Up @@ -40,6 +42,10 @@ If you'd like to run the website locally on your machine, follow these steps:

After running this command, the website should be accessible via http://localhost:3000 or another port specified in the console.

## Contributing

For more details on contributing to the project, please visit [CONTRIBUTING.md](CONTRIBUTING.md).

## Credits

Created by: Wilson Goins, Anton Salvador, Xael Font, Edward Roshko, Ryder Keeny, Nicolas Valiente, and Tyra Passion.
Expand Down