Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (64 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

107 lines (64 loc) · 3.17 KB

Contributing to Festify

Thank you for your interest in contributing to Festify! We welcome contributions from the open-source community to help us improve and grow this project. Whether you're a developer, designer, tester, or documentation enthusiast, your contributions are valuable to us.

Getting Started

Before you start contributing, please follow these steps to set up your development environment and understand our project's workflow.

1. Fork the Repository

Click the "Fork" button at the top-right corner of this repository to create a copy of it in your GitHub account.

2. Clone Your Fork

Clone your forked repository to your local development environment:

git clone https://github.com/<your-username>/festify.git

3. Install Dependencies

Navigate to the project's directory and install the required dependencies accordingly for frontend and backend respectively:

cd festify/web
npm install
cd festify/server
npm install

4. Create a Branch

Create a new branch for your contribution(feature/bugfix/issue etc):

git checkout -b feature/your-feature

5. Make Changes

Make your desired changes or additions to the code, documentation, or other project assets.

6. Test Your Changes

Ensure that your changes do not introduce any errors or break existing functionality. Run tests if applicable.

7. Commit Your Changes

Commit your changes with a descriptive commit message:

git commit -m "Add your descriptive commit message here"

8. Push Your Changes

Push your changes to your forked repository:

git push origin feature/your-feature

9. Create a Pull Request

Visit the original repository on GitHub and create a pull request (PR) from your forked branch to the main project's branch. Be sure to provide a clear title and description for your PR.

Contribution Guidelines

To ensure a smooth contribution process, please adhere to the following guidelines:

  • Only work on issues that have been assigned to you or that you have been given permission to work on.
  • If you want to work on a new feature or bug fix, create an issue first to discuss it with the project maintainers.

Code Style and Standards

  • Follow the coding style and standards used in the project.
  • Write clear and concise code with appropriate comments where necessary.

Testing

  • Ensure that your code passes all existing tests.
  • If you're adding new features, consider adding relevant test cases if applicable.

Documentation

  • Update documentation, if applicable, to reflect your changes.
  • If you're introducing new features, include clear usage instructions.

Commit Messages

  • Use clear and meaningful commit messages.
  • Reference relevant issues or pull requests in your commits using keywords, e.g. Fixes Issue #123, Closes PR #456, etc.

Be Respectful

  • Be respectful and considerate in your interactions with other contributors and maintainers.
  • Follow the project's code of conduct.

Code of Conduct

Please review and follow our Code of Conduct. We aim to create a welcoming and inclusive community for all contributors.

Thank you for contributing to Festify!