CONTRIBUTING.md

💥 How to Contribute

• Take a look at the existing Issues or create a new issue!
• Fork the Repo, create a branch for any issue that you are working on and commit your work.
• Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
• Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes that are included in your commits.

⭐ HOW TO MAKE A PULL REQUEST:

1. Start by making a fork the EventCalendar repository. Click on the symbol at the top right corner.

2. Clone your new fork of the repository:

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

3. Set upstream command:

git remote add upstream https://github.com/EddieHubCommunity/EventCalendar.git

4. Navigate to the new project directory:

cd EventCalendar

5. Create a new branch:

git checkout -b YourBranchName

6. Sync your fork or local repository with the origin repository:

• In your forked repository click on "Fetch upstream"
• Click "Fetch and merge".

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream

git merge upstream/main

Github Docs for Syncing

7. Make your changes to the source code.

8. Stage your changes and commit:

git add public

git commit -m "<your_commit_message>"

9. Push your local commits to the remote repository:

git push origin YourBranchName

10. Create a Pull Request!

11. Congratulations! You've made your first contribution to EventCalendar! 🙌🏼

🏆 After this, the maintainers will review the PR and will merge it if it helps move the EventCalendar project forward. Otherwise, it will be given constructive feedback and suggestions for the changes needed to add the PR to the codebase.

📝 Style Guide for Git Commit Messages

How you can add more value to your contribution logs:

• Use the present tense. (Example: "Add feature" instead of "Added feature")
• Use the imperative mood. (Example: "Move item to...", instead of "Moves item to...")
• Limit the first line (also called the Subject Line) to 50 characters or less.
• Capitalize the Subject Line.
• Separate subject from body with a blank line.
• Do not end the subject line with a period.
• Wrap the body at 72 characters.
• Use the body to explain the what, why, vs, and how.
• Reference Issues and Pull Requests liberally after the first line.

💥 Issues

For major changes, you are welcome to open an issue about what you would like to contribute. Enhancements are always encouraged and appreciated.

🥇 All the best!