Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve the repository's contributor-friendliness #38

Closed
your-valentine opened this issue Mar 1, 2023 · 6 comments
Closed

improve the repository's contributor-friendliness #38

your-valentine opened this issue Mar 1, 2023 · 6 comments

Comments

@your-valentine
Copy link

TLTR: Its frustrating to setup the dev environment with the current information given...

I have noticed that the repository is missing both the necessary SQL structures and environment-specific files required to set up the development environment.

From my perspective, this makes it extremely difficult to contribute. Therefore, I suggest that the project owners consider including the required SQL structures and other-specific files.

@LeoCx1000
Copy link
Member

Hey there! Thanks for taking interest in contributing to DuckBot. I really appreciate it.

Currently, the main focus of the project is the branch:rewrite. There you will find the schema.sql and utils/example.env files, and soon, proper contributing guidelines and proper information on how to run the bot (see #33 and branch:LeoCx1000/contributing-guide).

Currently, the branch:master is "legacy" meaning I am only doing bug fixes there as it's not my main focus. That being I will commit a schema and .env templates to it since it's a fairly quick and straight-forwards process, and give quick information about contributing to facilitate the process. 👍

@your-valentine
Copy link
Author

your-valentine commented Mar 1, 2023

TLTR: Thank you for your prompt reply and for providing the information about the development focus of the project.

I appreciate your efforts to make the repository more contributor-friendly! 😊

I will keep an eye on the #33 issue and the branch:LeoCx1000/contributing-guide to get the latest updates.
In the meantime, I will make sure to keep the master branch on my radar and will be awaiting the addition of the schema and .example.env templates to it.

Just a friendly heads up, I noticed that the branch:LeoCx1000/contributing-guide is a bit of a mess at the moment, with 423 commits and 198 files changed. It's hard to keep track of everything in there! 🙈

I understand that things can get a bit hectic during development, but I thought I'd mention it in case it's something that can be addressed in the future.

Thank you again, and have a great day! 🦆💫

@LeoCx1000
Copy link
Member

No problem! I've updated the master branch with the information.

Just a friendly heads up, I noticed that the branch:LeoCx1000/contributing-guide is a bit of a mess at the moment, with 423 commits and 198 files changed. It's hard to keep track of everything in there! 🙈

Yeah, I'm aware. That branch is based off rewrite not master, but GitHub shows that information relative to the current default branch and I'm not sure how to address that to make it show properly relative to it's derived branch.

@your-valentine
Copy link
Author

🙂 I understand your perspective, but I'm not sure if adding the changes directly to the "rewrite" branch is the best option. As I mentioned, the branch is a bit "messy", so it might be better to create a new branch from "main" and add the necessary changes using the "git add" command.

After you have made the changes and committed them, you can merge them into the "rewrite" branch. This will ensure that the changes are based on a clean and up-to-date version of the codebase.

I hope that helps! Let me know if you have any questions or concerns. 😊

@LeoCx1000
Copy link
Member

I believe basing my branch from master would not work since as I mentioned before, the master branch is legacy code. It is behind rewrite, and my contributing guidelines branch targets rewrite. That being said, I plan on changing the default branch to rewrite when the contributing guidelines are merged, so the tally displays properly.

@cyrus01337
Copy link
Contributor

If there are also issues with setting up your environment until rewrite becomes the de-facto branch, the community and myself would be more than happy to assist in the meantime - I happen to have a testing version working thanks to them! 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants