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

Procedure of How to Suggest New Code #42

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jolly-fellow
Copy link

Description of How to Suggest New Code, Documentation, or Other Development Artifacts


Our project management system is driven by issues, which means that it tracks tasks through issues rather than pull requests. To propose a new activity, such as reporting a bug or making changes to the repository, you need to create an issue with a detailed description of what changes you want to make and why they are important. The issue will be discussed at a developer meeting, and if it is deemed necessary, it will be added to a sprint, and a developer will be assigned to work on it.

However, there are cases when you have already made changes to the code or documentation that address the issue you want to create. For example, you may have conducted initiative research, tested your ideas, experimented with the code, made many modifications, and then found a significant improvement that makes the project much faster. Alternatively, while working on another task, you may have discovered and fixed a bug. In these cases, you already have a set of modifications that you want to suggest adding to the repository.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like making something like this an official process may enable contributors to work too much on things that may not have been deemed a priority by the team. We need to discuss this with the broader team but I am less supportive of this method than previous discussions about how to manage PRs without issues assigned in the future.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not believe every PR requires an issue. For example, misspelling or minor grammatical changes in code comments can be easily fixed and reviewed without needing the debate that this procedure outlines; however, there is a lot of value in communicating to outside contributors what the process for incorporating their changes into the product is.

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

Successfully merging this pull request may close these issues.

3 participants