CONTRIBUTING.md

Contributing to Lyceum

Please read the TO-DO LIST before contributing.

Contribution Scope:

• Reporting an issue
• Discussing the current state of the code
• Submitting a fix
• Proposing new features
• Becoming a maintainer

Development Process

All changes happen through pull requests. Pull requests are the best way to propose changes. All types of pull requests are welcome and you're invited to submit pull requests directly here, and after review, these can be merged into the project.

Using the Project's Standard Commit Messages

This project is using the conventional commits standard.

Pull Requests

1. Fork the repo and create your branch (usually named patch-%the number of PRs you've already made%) from main or use the branch named "develop".
2. If you've added code that should be tested, add some test examples.
3. Ensure to describe your pull request.

Quickstart

• Make sure you have both Node and npm as well as Expo installed on your machine.
  • Install Node: https://nodejs.org/en/
  • Expo: https://docs.expo.io/

Installation

1. Clone project

git clone https://github.com/rnair98/lyceum-react-native

2. cd into folder

cd lyceum-react-native

3. Download dependencies

npm install

4. Start Expo Server

expo start -w

Development

1. Fork repo from Github and clone project locally

git clone https://github.com/rnair98/lyceum-react-native

2. Connect your local project to the original repo on Github

git remote add origin https://github.com/rnair98/lyceum-react-native

3. Before making any changes, pull in any changes from “upstream”.

git pull

2. Change your branch to “develop”. All changes and commits will be made in this branch.

git checkout develop

2. After going through an editing workflow, stage and commit your changes with a message highlighting what kind of changes you made.

git add *
git commit -m "Insert Message Here"

3. Push your commits to Github

git push -u origin develop

4. Create a Pull Request on Github (For Reference: https://makeapullrequest.com/)

Issues

NOTE: If your bug is a security vulnerability, please instead see the security policy

Github Issues is the preferred method to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. Report a bug by opening a new issue

Frequently Asked Questions (FAQs)

- Q: [The Question?]
    - A: [The Answer!]

Feature Request

Great Feature Requests tend to have:

• A quick idea summary.
• What & why you wanted to add the specific feature.
• Additional context like images, links to resources to implement the feature etc, etc.

License

By contributing to Lyceum, you agree that your contributions will be licensed under the LICENSE file.