Skip to content

Latest commit

 

History

History
103 lines (61 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

103 lines (61 loc) · 2.77 KB

Contributing to FestGuest

Thank you for your interest in contributing to FestGuest! We welcome contributions from the community and are excited to see how you can help improve our project. Please read through this guide to understand how you can contribute.

Getting Started

1. Fork the Repository

Start by forking the repository to your GitHub account. This will create a copy of the project under your account.

2. Clone Your Fork

Clone the forked repository to your local machine using the following command:

git clone https://github.com/marco-nh/FestGuest

3. Create a Branch

Create a new branch for your changes:

git checkout -b your-branch-name

4. Install Dependencies

Navigate to the project directory and install the required dependencies:

cd FestGuest
npm install

Making Changes

Coding Standards

  • Ensure your code adheres to our coding standards and guidelines.
  • Use meaningful commit messages.
  • Keep your code clean and well-documented.

Adding Features or Fixing Bugs

  1. Open an Issue: Before starting, open an issue describing the feature you want to add or the bug you want to fix. This helps us track the progress and avoid duplicate efforts.
  2. Work on the Issue: Reference the issue number in your branch name and commit messages (e.g., feature/issue-123-new-feature).

Testing

Ensure your changes do not break existing functionality. Run the tests using:

npm test

Add new tests if necessary to cover your changes.

Submitting Your Contribution

1. Commit Your Changes

Commit your changes with a clear and descriptive message:

git commit -m "Fix issue #123: Describe the fix"

2. Push to Your Fork

Push your changes to your forked repository:

git push origin your-branch-name

3. Create a Pull Request

Go to the original repository on GitHub and create a pull request from your fork and branch. Provide a detailed description of your changes and link to the issue you addressed.

4. Review Process

Your pull request will be reviewed by our team. We might request changes or ask questions. Please be responsive and make the necessary updates.

5. Merge

Once your pull request is approved, it will be merged into the main branch. You will be credited for your contribution!

Community Guidelines

  • Be respectful and considerate of others.
  • Provide constructive feedback.
  • Follow the project's code of conduct.

Questions?

If you have any questions or need further assistance, feel free to open an issue or contact us at support@festguest.com.

Thank you for contributing to FestGuest! We appreciate your support.

Feel free to adjust the content as necessary to better fit your project's specific guidelines and practices.