diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..986a3f61 --- /dev/null +++ b/CONTRIBUTING.md @@ -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! + + + diff --git a/README.md b/README.md index f6e1ceb1..a6ce6ce7 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.