Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 2.89 KB

Contributing to Bloc

The following is a set of guidelines for contributing to Bloc, which are hosted in the Pharo Graphics Organization on GitHub.

Table Of Contents

What should I know before I get started?

User and Developer versions

To load the sources in a Pharo image, you have the choice between the User and Developer versions. More detailed informations are available here.

Being able to load the Developer version does not necessarily mean that you are allowed to contribute directly on the master branch. Only members of the Pharo Graphics Organization are able to make direct contributions (How Can I Contribute?).

Design Decisions

When we make a significant decision, we will document it in Issues or/and in pharo-graphics/design-decisions repository (soon). If you have a question around how we do things, check also to see if it is documented there. If it is not documented there, please open a new topic on Issues and ask your question.

How Can I Contribute?

Reporting bugs and suggesting enhancements

Before creating issues, please check this list as you might find out that you don't need to create one. When you are creating a new issue, please include as many details as possible to help maintainers reproduce the problem or understand your suggestion.

Submitting changes

Like most projects, we propose a standard GitHub Flow for contributions:

  1. Fork
  2. Create a topic branch
  3. Add commits
  4. Create a Pull Request
  5. Discuss and review your code
  6. Merge

If you want to submit changes, please send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). Please make sure all of your commits are atomic (one feature per commit) and always write a clear log message for your commits to help maintainers understand and review your submission.