Contributions are welcome, and this project is a great starting point for anyone looking to get involved in open-source development. Whether you’re new to contributing or a seasoned developer, your input is valued!
To get started with contributing, follow these steps:
- Fork the repository.
- Clone your fork to your local machine
git clone https://github.com/your-username/cc-next.git- Navigate to project directory
cd cc-next- Install dependencies
pnpm install- Create a new branch for your feature:
git checkout -b feature/my-new-feature- Make your changes and commit them:
git commit -m "feat: add some feature"- Push the branch to your fork:
git push origin feature/my-new-feature- Open a pull request to the main repository.
Before you create a Pull Request, please ensure that your commits adhere to the commit conventions used in this repository.
When you create a commit, follow the convention category: message in your commit message while using one of the following categories:
feat: changes that introduce completely new code or new featuresfix: changes that fix a bugdocs: documentation changes onlybuild: changes that affect the build system or external dependenciesci: changes related to the setup and configuration of continuous integration systemstest: adding missing tests or correcting existing testsrefactor: any code related change that is not a fix nor a featurechore: changes to the repository that do not fit into any of the above categories
The message contains a succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end
feat: add TypeScript support to the project
Learn more about Conventional Commits. If you are interested in the details.
Before committing your changes, please make sure to run the test to ensure that everything is working correctly. You can run the test using the following command:
pnpm run test